From 1840681c8de223040d2017d35ecefe89e04e2001 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:27 +0000 Subject: [PATCH 01/30] chore: update docs/dyn/index.md --- docs/dyn/index.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/dyn/index.md b/docs/dyn/index.md index f13bd7dc07..7ac878b956 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -179,6 +179,10 @@ * [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/assuredworkloads_v1beta1.html) +## auditmanager +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/auditmanager_v1.html) + + ## authorizedbuyersmarketplace * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/authorizedbuyersmarketplace_v1.html) * [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/authorizedbuyersmarketplace_v1alpha.html) @@ -187,6 +191,7 @@ ## backupdr * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/backupdr_v1.html) +* [v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/backupdr_v1beta.html) ## baremetalsolution @@ -524,7 +529,6 @@ ## dataproc * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/dataproc_v1.html) -* [v2](http://googleapis.github.io/google-api-python-client/docs/dyn/dataproc_v2.html) ## datastore @@ -780,6 +784,7 @@ ## health * [v4](http://googleapis.github.io/google-api-python-client/docs/dyn/health_v4.html) +* [v4beta](http://googleapis.github.io/google-api-python-client/docs/dyn/health_v4beta.html) ## healthcare From 7319764c93831281ff4465213879c97bb7c973a1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:27 +0000 Subject: [PATCH 02/30] feat(agentregistry): update the api #### agentregistry:v1 The following keys were added: - resources.projects.resources.locations.resources.aiApplications.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.locations.resources.aiApplications.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.aiApplications.methods.testIamPermissions (Total Keys: 12) - schemas.Expr (Total Keys: 4) - schemas.GoogleIamV1AuditConfig (Total Keys: 5) - schemas.GoogleIamV1AuditLogConfig (Total Keys: 5) - schemas.GoogleIamV1Binding (Total Keys: 6) - schemas.GoogleIamV1Policy (Total Keys: 8) - schemas.GoogleIamV1SetIamPolicyRequest (Total Keys: 5) - schemas.GoogleIamV1TestIamPermissionsRequest (Total Keys: 4) - schemas.GoogleIamV1TestIamPermissionsResponse (Total Keys: 4) #### agentregistry:v1alpha The following keys were added: - resources.projects.resources.locations.resources.aiApplications.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.locations.resources.aiApplications.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.aiApplications.methods.testIamPermissions (Total Keys: 12) - resources.projects.resources.locations.resources.skills.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.locations.resources.skills.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.skills.methods.testIamPermissions (Total Keys: 12) - schemas.Expr (Total Keys: 4) - schemas.GoogleIamV1AuditConfig (Total Keys: 5) - schemas.GoogleIamV1AuditLogConfig (Total Keys: 5) - schemas.GoogleIamV1Binding (Total Keys: 6) - schemas.GoogleIamV1Policy (Total Keys: 8) - schemas.GoogleIamV1SetIamPolicyRequest (Total Keys: 5) - schemas.GoogleIamV1TestIamPermissionsRequest (Total Keys: 4) - schemas.GoogleIamV1TestIamPermissionsResponse (Total Keys: 4) --- ..._v1.projects.locations.aiApplications.html | 258 +++++++++++++ .../agentregistry_v1.projects.locations.html | 5 + ...pha.projects.locations.aiApplications.html | 258 +++++++++++++ ...ntregistry_v1alpha.projects.locations.html | 5 + ...try_v1alpha.projects.locations.skills.html | 172 +++++++++ .../documents/agentregistry.v1.json | 268 ++++++++++++- .../documents/agentregistry.v1alpha.json | 362 +++++++++++++++++- 7 files changed, 1326 insertions(+), 2 deletions(-) create mode 100644 docs/dyn/agentregistry_v1.projects.locations.aiApplications.html create mode 100644 docs/dyn/agentregistry_v1alpha.projects.locations.aiApplications.html diff --git a/docs/dyn/agentregistry_v1.projects.locations.aiApplications.html b/docs/dyn/agentregistry_v1.projects.locations.aiApplications.html new file mode 100644 index 0000000000..2e8953f6f1 --- /dev/null +++ b/docs/dyn/agentregistry_v1.projects.locations.aiApplications.html @@ -0,0 +1,258 @@ + + + +

Agent Registry API . projects . locations . aiApplications

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

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

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ 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).
+}
+
+ +
+ 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",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentregistry_v1.projects.locations.html b/docs/dyn/agentregistry_v1.projects.locations.html index d070f0f487..30764f03ff 100644 --- a/docs/dyn/agentregistry_v1.projects.locations.html +++ b/docs/dyn/agentregistry_v1.projects.locations.html @@ -79,6 +79,11 @@

Instance Methods

Returns the agents Resource.

+

+ aiApplications() +

+

Returns the aiApplications Resource.

+

bindings()

diff --git a/docs/dyn/agentregistry_v1alpha.projects.locations.aiApplications.html b/docs/dyn/agentregistry_v1alpha.projects.locations.aiApplications.html new file mode 100644 index 0000000000..10caa9bff9 --- /dev/null +++ b/docs/dyn/agentregistry_v1alpha.projects.locations.aiApplications.html @@ -0,0 +1,258 @@ + + + +

Agent Registry API . projects . locations . aiApplications

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

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

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ 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).
+}
+
+ +
+ 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",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/agentregistry_v1alpha.projects.locations.html b/docs/dyn/agentregistry_v1alpha.projects.locations.html index c110bd2834..5f1e707216 100644 --- a/docs/dyn/agentregistry_v1alpha.projects.locations.html +++ b/docs/dyn/agentregistry_v1alpha.projects.locations.html @@ -79,6 +79,11 @@

Instance Methods

Returns the agents Resource.

+

+ aiApplications() +

+

Returns the aiApplications Resource.

+

bindings()

diff --git a/docs/dyn/agentregistry_v1alpha.projects.locations.skills.html b/docs/dyn/agentregistry_v1alpha.projects.locations.skills.html index 06135d7d3b..839ec6dc93 100644 --- a/docs/dyn/agentregistry_v1alpha.projects.locations.skills.html +++ b/docs/dyn/agentregistry_v1alpha.projects.locations.skills.html @@ -91,6 +91,9 @@

Instance Methods

get(name, x__xgafv=None)

Fetches the active configuration and metadata of a Skill.

+

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

get_media(name, x__xgafv=None)

Fetches the active configuration and metadata of a Skill.

@@ -109,6 +112,12 @@

Instance Methods

search_next(previous_request, previous_response)

Retrieves the next page of results.

+

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

Method Details

close() @@ -303,6 +312,54 @@

Method Details

}
+
+ 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).
+}
+
+
get_media(name, x__xgafv=None)
Fetches the active configuration and metadata of a Skill.
@@ -588,4 +645,119 @@ 

Method Details

+
+ 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",
+  ],
+}
+
+ \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/agentregistry.v1.json b/googleapiclient/discovery_cache/documents/agentregistry.v1.json index cbc327656e..11dc54fdea 100644 --- a/googleapiclient/discovery_cache/documents/agentregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/agentregistry.v1.json @@ -310,6 +310,104 @@ } } }, +"aiApplications": { +"methods": { +"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}/aiApplications/{aiApplicationsId}:getIamPolicy", +"httpMethod": "GET", +"id": "agentregistry.projects.locations.aiApplications.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/[^/]+/aiApplications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"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" +] +}, +"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}/aiApplications/{aiApplicationsId}:setIamPolicy", +"httpMethod": "POST", +"id": "agentregistry.projects.locations.aiApplications.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/[^/]+/aiApplications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-write", +"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}/aiApplications/{aiApplicationsId}:testIamPermissions", +"httpMethod": "POST", +"id": "agentregistry.projects.locations.aiApplications.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/[^/]+/aiApplications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"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" +] +} +} +}, "bindings": { "methods": { "create": { @@ -1077,7 +1175,7 @@ } } }, -"revision": "20260821", +"revision": "20260904", "rootUrl": "https://agentregistry.googleapis.com/", "schemas": { "A2ASkill": { @@ -1455,6 +1553,29 @@ }, "type": "object" }, +"Expr": { +"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", +"id": "Expr", +"properties": { +"description": { +"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", +"type": "string" +}, +"expression": { +"description": "Textual representation of an expression in Common Expression Language syntax.", +"type": "string" +}, +"location": { +"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", +"type": "string" +}, +"title": { +"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", +"type": "string" +} +}, +"type": "object" +}, "FetchAvailableBindingsResponse": { "description": "Message for response to fetching available Bindings.", "id": "FetchAvailableBindingsResponse", @@ -1473,6 +1594,151 @@ }, "type": "object" }, +"GoogleIamV1AuditConfig": { +"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": "GoogleIamV1AuditConfig", +"properties": { +"auditLogConfigs": { +"description": "The configuration for logging of each type of permission.", +"items": { +"$ref": "GoogleIamV1AuditLogConfig" +}, +"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" +}, +"GoogleIamV1AuditLogConfig": { +"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": "GoogleIamV1AuditLogConfig", +"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" +}, +"GoogleIamV1Binding": { +"description": "Associates `members`, or principals, with a `role`.", +"id": "GoogleIamV1Binding", +"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" +}, +"GoogleIamV1Policy": { +"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": "GoogleIamV1Policy", +"properties": { +"auditConfigs": { +"description": "Specifies cloud audit logging configuration for this policy.", +"items": { +"$ref": "GoogleIamV1AuditConfig" +}, +"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": "GoogleIamV1Binding" +}, +"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" +}, +"GoogleIamV1SetIamPolicyRequest": { +"description": "Request message for `SetIamPolicy` method.", +"id": "GoogleIamV1SetIamPolicyRequest", +"properties": { +"policy": { +"$ref": "GoogleIamV1Policy", +"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" +}, +"GoogleIamV1TestIamPermissionsRequest": { +"description": "Request message for `TestIamPermissions` method.", +"id": "GoogleIamV1TestIamPermissionsRequest", +"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" +}, +"GoogleIamV1TestIamPermissionsResponse": { +"description": "Response message for `TestIamPermissions` method.", +"id": "GoogleIamV1TestIamPermissionsResponse", +"properties": { +"permissions": { +"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "Interface": { "description": "Represents the connection details for an Agent or MCP Server.", "id": "Interface", diff --git a/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json b/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json index 99473a8494..68f323f8a4 100644 --- a/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json @@ -310,6 +310,104 @@ } } }, +"aiApplications": { +"methods": { +"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}/aiApplications/{aiApplicationsId}:getIamPolicy", +"httpMethod": "GET", +"id": "agentregistry.projects.locations.aiApplications.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/[^/]+/aiApplications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"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" +] +}, +"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}/aiApplications/{aiApplicationsId}:setIamPolicy", +"httpMethod": "POST", +"id": "agentregistry.projects.locations.aiApplications.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/[^/]+/aiApplications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-write", +"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}/aiApplications/{aiApplicationsId}:testIamPermissions", +"httpMethod": "POST", +"id": "agentregistry.projects.locations.aiApplications.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/[^/]+/aiApplications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"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" +] +} +} +}, "bindings": { "methods": { "create": { @@ -1254,6 +1352,40 @@ "supportsMediaDownload": true, "useMediaDownloadService": true }, +"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}/skills/{skillsId}:getIamPolicy", +"httpMethod": "GET", +"id": "agentregistry.projects.locations.skills.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/[^/]+/skills/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"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", @@ -1408,6 +1540,66 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] +}, +"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}/skills/{skillsId}:setIamPolicy", +"httpMethod": "POST", +"id": "agentregistry.projects.locations.skills.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/[^/]+/skills/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-write", +"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}/skills/{skillsId}:testIamPermissions", +"httpMethod": "POST", +"id": "agentregistry.projects.locations.skills.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/[^/]+/skills/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"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": { @@ -1565,7 +1757,7 @@ } } }, -"revision": "20260827", +"revision": "20260904", "rootUrl": "https://agentregistry.googleapis.com/", "schemas": { "A2ASkill": { @@ -1955,6 +2147,29 @@ }, "type": "object" }, +"Expr": { +"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", +"id": "Expr", +"properties": { +"description": { +"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", +"type": "string" +}, +"expression": { +"description": "Textual representation of an expression in Common Expression Language syntax.", +"type": "string" +}, +"location": { +"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", +"type": "string" +}, +"title": { +"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", +"type": "string" +} +}, +"type": "object" +}, "FetchAvailableBindingsResponse": { "description": "Message for response to fetching available Bindings.", "id": "FetchAvailableBindingsResponse", @@ -2019,6 +2234,151 @@ }, "type": "object" }, +"GoogleIamV1AuditConfig": { +"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": "GoogleIamV1AuditConfig", +"properties": { +"auditLogConfigs": { +"description": "The configuration for logging of each type of permission.", +"items": { +"$ref": "GoogleIamV1AuditLogConfig" +}, +"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" +}, +"GoogleIamV1AuditLogConfig": { +"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": "GoogleIamV1AuditLogConfig", +"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" +}, +"GoogleIamV1Binding": { +"description": "Associates `members`, or principals, with a `role`.", +"id": "GoogleIamV1Binding", +"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" +}, +"GoogleIamV1Policy": { +"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": "GoogleIamV1Policy", +"properties": { +"auditConfigs": { +"description": "Specifies cloud audit logging configuration for this policy.", +"items": { +"$ref": "GoogleIamV1AuditConfig" +}, +"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": "GoogleIamV1Binding" +}, +"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" +}, +"GoogleIamV1SetIamPolicyRequest": { +"description": "Request message for `SetIamPolicy` method.", +"id": "GoogleIamV1SetIamPolicyRequest", +"properties": { +"policy": { +"$ref": "GoogleIamV1Policy", +"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" +}, +"GoogleIamV1TestIamPermissionsRequest": { +"description": "Request message for `TestIamPermissions` method.", +"id": "GoogleIamV1TestIamPermissionsRequest", +"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" +}, +"GoogleIamV1TestIamPermissionsResponse": { +"description": "Response message for `TestIamPermissions` method.", +"id": "GoogleIamV1TestIamPermissionsResponse", +"properties": { +"permissions": { +"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "Interface": { "description": "Represents the connection details for an Agent or MCP Server.", "id": "Interface", From 2efc53079fec2b2589dd7d4298f3db3a962d38ce Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:27 +0000 Subject: [PATCH 03/30] feat(aiplatform): update the api #### aiplatform:v1beta1 The following keys were deleted: - schemas.GenaiVertexV1beta1CodeExecutionCallContent (Total Keys: 4) - schemas.GenaiVertexV1beta1CodeExecutionResultContent (Total Keys: 5) - schemas.GenaiVertexV1beta1Content.properties.thought (Total Keys: 2) - schemas.GenaiVertexV1beta1Content.properties.toolCall (Total Keys: 2) - schemas.GenaiVertexV1beta1Content.properties.toolResult (Total Keys: 2) - schemas.GenaiVertexV1beta1ContentDelta (Total Keys: 17) - schemas.GenaiVertexV1beta1ContentStart (Total Keys: 5) - schemas.GenaiVertexV1beta1ContentStop (Total Keys: 4) - schemas.GenaiVertexV1beta1FileSearchCallContent (Total Keys: 3) - schemas.GenaiVertexV1beta1FileSearchResultContent (Total Keys: 5) - schemas.GenaiVertexV1beta1FunctionCallContent (Total Keys: 5) - schemas.GenaiVertexV1beta1FunctionCallDelta (Total Keys: 4) - schemas.GenaiVertexV1beta1FunctionResultContent (Total Keys: 8) - schemas.GenaiVertexV1beta1FunctionResultSubcontent (Total Keys: 8) - schemas.GenaiVertexV1beta1GoogleMapsCallContent (Total Keys: 4) - schemas.GenaiVertexV1beta1GoogleMapsResultContent (Total Keys: 5) - schemas.GenaiVertexV1beta1GoogleSearchCallContent (Total Keys: 5) - schemas.GenaiVertexV1beta1GoogleSearchResultContent (Total Keys: 6) - schemas.GenaiVertexV1beta1Interaction.properties.contentList (Total Keys: 2) - schemas.GenaiVertexV1beta1Interaction.properties.outputs (Total Keys: 4) - schemas.GenaiVertexV1beta1Interaction.properties.responseFormat (Total Keys: 2) - schemas.GenaiVertexV1beta1Interaction.properties.role (Total Keys: 3) - schemas.GenaiVertexV1beta1InteractionCompleteEvent (Total Keys: 4) - schemas.GenaiVertexV1beta1InteractionStartEvent (Total Keys: 4) - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.contentDelta (Total Keys: 2) - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.contentStart (Total Keys: 2) - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.contentStop (Total Keys: 2) - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.interactionCompleteEvent (Total Keys: 2) - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.interactionStartEvent (Total Keys: 2) - schemas.GenaiVertexV1beta1McpServerToolCallContent (Total Keys: 5) - schemas.GenaiVertexV1beta1McpServerToolResultContent (Total Keys: 7) - schemas.GenaiVertexV1beta1ThoughtContent (Total Keys: 7) - schemas.GenaiVertexV1beta1ThoughtSummaryContent (Total Keys: 4) - schemas.GenaiVertexV1beta1ToolCallContent (Total Keys: 12) - schemas.GenaiVertexV1beta1ToolCallDelta (Total Keys: 11) - schemas.GenaiVertexV1beta1ToolResultContent (Total Keys: 12) - schemas.GenaiVertexV1beta1ToolResultDelta (Total Keys: 11) The following keys were added: - resources.projects.resources.locations.resources.evaluationExperiments.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.evaluationExperiments.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.evaluationExperiments.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.evaluationExperiments.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.evaluationExperiments.methods.patch (Total Keys: 15) - resources.projects.resources.locations.resources.monitoredAgents.methods.clearTrainingData (Total Keys: 12) - schemas.GoogleCloudAiplatformV1beta1A2APart.properties.data.additionalProperties.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ClearTrainingDataRequest (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1DiscoveryEngineAssistantConfig (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1EvaluationExperiment (Total Keys: 16) - schemas.GoogleCloudAiplatformV1beta1EvaluationRun.properties.evaluationExperiment.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentRunConfig.properties.discoveryEngineAssistantConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ListEvaluationExperimentsResponse (Total Keys: 5) The following keys were changed: - schemas.GoogleCloudAiplatformV1beta1A2APart.properties.data.type (Total Keys: 1) --- ...platform_v1.projects.locations.agents.html | 10 +- docs/dyn/aiplatform_v1beta1.interactions.html | 64943 ++----------- ...orm_v1beta1.projects.locations.agents.html | 10 +- ...jects.locations.evaluationExperiments.html | 325 + ...ta1.projects.locations.evaluationRuns.html | 16 + ...aiplatform_v1beta1.projects.locations.html | 5 + ...beta1.projects.locations.interactions.html | 75386 ++-------------- ...a1.projects.locations.monitoredAgents.html | 44 + ...ions.taskStores.a2aTaskRecords.events.html | 16 +- ...s.locations.taskStores.a2aTaskRecords.html | 76 +- .../documents/aiplatform.v1.json | 4 +- .../documents/aiplatform.v1beta1.json | 917 +- 12 files changed, 18683 insertions(+), 123069 deletions(-) create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.evaluationExperiments.html diff --git a/docs/dyn/aiplatform_v1.projects.locations.agents.html b/docs/dyn/aiplatform_v1.projects.locations.agents.html index 814061c9a5..46ae20aae5 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.agents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.agents.html @@ -136,7 +136,7 @@

Method Details

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

Method Details

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

Method Details

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

Method Details

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

Method Details

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

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -557,454 +296,149 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, + "processingType": "A String", + "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. + "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. + { # Error message from an interaction. + "code": "A String", # A URI that identifies the error type. + "message": "A String", # A human-readable error message. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "labels": { # 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`. }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "seed": 42, # Seed used in decoding for reproducibility. + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. + "speakers": [ # Individual speaker configurations. + { # 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. }, ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, + "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", ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "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", ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, + "customVocabulary": [ # Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + "A String", ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - }, + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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", ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, + "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. }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. }, + "model": "A String", # The name of the `Model` used for generating the completion. }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "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", + }, }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. + ], + }, + "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 Cloud Storage, this is the Cloud Storage path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -1050,454 +484,268 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + }, + "processingType": "A String", "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - }, - "processingType": "A String", - "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. - "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. - { # Error message from an interaction. - "code": "A String", # A URI that identifies the error type. - "message": "A String", # A human-readable error message. - }, - ], - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "labels": { # 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. - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. - "speakers": [ # Individual speaker configurations. - { # 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. - }, - ], - }, - "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". - "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of 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": { # 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "processingType": "A String", + "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. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + }, + ], }, }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # 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": { # 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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "processingType": "A String", + "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. + }, }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -1543,323 +791,489 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - }, - "processingType": "A String", - "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", - }, - }, - ], + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. }, - "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 Cloud Storage, this is the Cloud Storage 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "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", + ], + "safetySettings": [ # 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. + }, + ], + "serviceTier": "A String", # The service tier for 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], - "text": "A String", # Required. The text content. + "processingType": "A String", + "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`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "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. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to 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": [ # The results of the File Search. - { # The result of the File Search. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset 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. # NOTE: We use these instead of the Citation message for historical reasons. 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. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of 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", # URI reference of the place. + "nullValue": "A String", # Represents a null value. + "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", # Resource name of the Google Maps widget context token. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "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", + ], }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, + "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. + "queries": [ # Queries for Retrieval information. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -1905,1389 +1319,468 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "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", }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + ], + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. # NOTE: We use these instead of the Citation message for historical reasons. 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "processingType": "A String", - "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. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - }, - ], + "serverName": "A String", # The name of the used MCP server. + }, + "processingResult": { # The result of a server-initiated media processing step. + }, + "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + }, + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - "listValue": { # `ListValue` is 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. + "processingType": "A String", + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. + "contentString": "A String", # The content of the step. A single 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. - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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`. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. # NOTE: We use these instead of the Citation message for historical reasons. 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "processingType": "A String", - "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. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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`. }, }, - ], - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. @@ -3299,145 +1792,198 @@

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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "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. # NOTE: We use these instead of the Citation message for historical reasons. 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "nullValue": "A String", # Represents a null value. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "processingType": "A String", - "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. + }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, + "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. + "queries": [ # Queries for Retrieval information. + "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", + ], + }, + }, }, - }, - "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. - }, - }, - "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. - "safetySettings": [ # 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. - }, - ], - "serviceTier": "A String", # The service tier for 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. + "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. @@ -3495,276 +2041,15 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, "processingType": "A String", @@ -3772,21 +2057,51 @@

Method Details

"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. + "listValue": { # `ListValue` is 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. }, }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. + "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. @@ -3844,266 +2159,110 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, + "processingType": "A String", + "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": [ # The results of the File Search. - { # The result of the File Search. + }, + "listValue": { # `ListValue` is 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. + }, + "processingResult": { # The result of a server-initiated media processing step. + }, + "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. # NOTE: We use these instead of the Citation message for historical reasons. 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. @@ -4123,783 +2282,320 @@

Method Details

}, ], }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. + }, + }, + ], + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "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. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. + "nullValue": "A String", # Represents a null value. + "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", + ], }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + ], + "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. + "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. }, - "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. + }, + "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. + "customConfig": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. }, - "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. + }, + "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "ragResources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. "A String", ], }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rankService": { # Config for Rank Service. # Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertexAiSearchConfig": { # 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. + }, + }, + ], + "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). + }, +} + + +
+ close() +
Close httplib2 connections.
+
+ +
+ getPoll(name, includeInput=None, lastEventId=None, stream=None, x__xgafv=None) +
Fully typed proto, unary version of GetInteraction that returns Interaction proto.
+
+Args:
+  name: string, Required. The name of the interaction to retrieve. Format: interactions/{interaction} (required)
+  includeInput: boolean, If true, includes the input in the response.
+  lastEventId: string, If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.
+  stream: boolean, If true, streams the interaction events as Server-Sent Events.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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.
+      "findRequest": { # 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.
+        "findingId": "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.
+        "sourceFiles": [ # 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.
+          },
+        ],
+      },
+      "fixRequest": { # 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.
+        "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability.
+        "sourceFiles": [ # 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.
+      "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior.
+        "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout.
+      },
+      "sessionId": "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.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
                   "sampleRate": 42, # The sample rate of the audio.
                   "uri": "A String", # The URI of the audio.
                 },
@@ -4953,281 +2649,20 @@ 

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "processingType": "A String", + "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`. @@ -5241,266 +2676,325 @@

Method Details

"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", - }, - ], + ], + }, + }, + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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 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. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of 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 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. + { # Error message from an interaction. + "code": "A String", # A URI that identifies the error type. + "message": "A String", # A human-readable error message. + }, + ], + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "labels": { # 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. + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. + "speakers": [ # Individual speaker configurations. + { # 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. + }, + ], + }, + "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". + "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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. + }, + "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 Cloud Storage, this is the Cloud Storage path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + }, + }, + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. - { + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -5512,649 +3006,482 @@

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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "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. # NOTE: We use these instead of the Citation message for historical reasons. 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "processingType": "A String", - "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. - }, - "serverName": "A String", # The name of the used MCP server. - }, - "processingResult": { # The result of a server-initiated media processing step. - }, - "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. - "isError": True or False, # Whether the retrieval resulted in an error. - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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": { # 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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. + }, + }, + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, + "processingType": "A String", + "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + }, + }, + ], + }, + }, + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. + }, + }, + "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", + ], + "safetySettings": [ # 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. + }, + ], + "serviceTier": "A String", # The service tier for 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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. }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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": [ # 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -6200,47 +3527,73 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of 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", # 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -6286,282 +3639,102 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - }, - "processingType": "A String", - "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. }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, + "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. + "queries": [ # Queries for Retrieval information. + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, + "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", ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments 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. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. @@ -6573,1318 +3746,464 @@

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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "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. # NOTE: We use these instead of the Citation message for historical reasons. 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "processingType": "A String", - "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 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, + "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. }, - "processingType": "A String", - "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", }, ], }, - "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", + "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. + }, ], }, - "searchType": "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - }, - ], + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - "listValue": { # `ListValue` is 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. + "processingType": "A String", + "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. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). - }, - "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. - "queries": [ # Queries for Retrieval information. - "A String", - ], + "processingResult": { # The result of a server-initiated media processing step. }, - "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", + "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. + }, ], }, }, - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "processingType": "A String", - "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", + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - ], - "widgetContextToken": "A String", + }, + "processingType": "A String", + "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. + }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -7930,266 +4249,183 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "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. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # 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. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, + "listValue": { # `ListValue` is 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. }, - "processingType": "A String", - "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. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - "processingResult": { # The result of a server-initiated media processing step. + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). }, - "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. + "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. @@ -8247,266 +4483,123 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, + "processingType": "A String", + "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": [ # The results of the File Search. - { # The result of the File Search. + }, + "listValue": { # `ListValue` is 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", }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", + }, + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. # NOTE: We use these instead of the Citation message for historical reasons. 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. @@ -8524,17 +4617,122 @@

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. + }, + "serverName": "A String", # The name of the used MCP server. + }, + "processingResult": { # The result of a server-initiated media processing step. + }, + "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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. + }, ], }, - "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. + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + }, + }, + ], + "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. @@ -8616,353 +4814,92 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, + }, + "processingType": "A String", + "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. + "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. + "customConfig": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "ragResources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "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", - ], - }, - }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "apiKey": "A String", # Required. The API key for ExaAiSearch. - "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. - "customConfig": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "ragResources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rankService": { # Config for Rank Service. # Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rankService": { # Config for Rank Service. # Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. }, }, "topK": 42, # Optional. The number of contexts to retrieve. @@ -9027,13 +4964,8 @@

Method Details

- close() -
Close httplib2 connections.
-
- -
- getPoll(name, includeInput=None, lastEventId=None, stream=None, x__xgafv=None) -
Fully typed proto, unary version of GetInteraction that returns Interaction proto.
+    getStream(name, includeInput=None, lastEventId=None, stream=None, x__xgafv=None)
+  
Fully typed proto, streaming version of GetInteraction that returns Interaction proto.
 
 Args:
   name: string, Required. The name of the interaction to retrieve. Format: interactions/{interaction} (required)
@@ -9048,910 +4980,565 @@ 

Method Details

Returns: An object of the form: - { # 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. + { + "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. }, - "codeMenderConfig": { # Configuration for the CodeMender agent. - "findRequest": { # 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. - "findingId": "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. - "sourceFiles": [ # 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. - }, - ], - }, - "fixRequest": { # 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. - "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. - "sourceFiles": [ # 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. + }, + "eventId": "A String", # The event_id token to be used to resume the interaction stream, from this event. + "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. + "findRequest": { # 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. + "findingId": "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. + "sourceFiles": [ # 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. + }, + ], }, - ], - }, - "model": "A String", # The name of the model to use for the CodeMender agent. One CodeMender session will only use one model. - "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. - "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. - }, - "sessionId": "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, + "fixRequest": { # 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. + "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "sourceFiles": [ # 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. + "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "sessionId": "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "searchType": "A String", # The type of search grounding enabled. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - }, + "listValue": { # `ListValue` is 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 + ], + }, + }, + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "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. + "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. + { # Error message from an interaction. + "code": "A String", # A URI that identifies the error type. + "message": "A String", # A human-readable error message. + }, + ], + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "labels": { # 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`. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "seed": 42, # Seed used in decoding for reproducibility. + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. + "speakers": [ # Individual speaker configurations. + { # 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. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "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", + ], + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, + "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". + "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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", ], - "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": [ # The results of the File Search. - { # The result of the File Search. + "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. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. + "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", }, }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user 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. + "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 Cloud Storage, this is the Cloud Storage path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", }, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - ], - "url": "A String", # URI reference of the place. + "processingType": "A String", + "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. # NOTE: We use these instead of the Citation message for historical reasons. 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 + ], }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. + "nullValue": "A String", # Represents a null value. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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 - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # 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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. + }, }, ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "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. }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "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. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -9997,1282 +5584,688 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + }, + "processingType": "A String", "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. + "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. + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. }, }, - ], - }, - "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. - "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. - { # Error message from an interaction. - "code": "A String", # A URI that identifies the error type. - "message": "A String", # A human-readable error message. - }, - ], - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "labels": { # 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. - "stopSequences": [ # A list of character sequences that will stop output interaction. + "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", ], - "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. - "speakers": [ # Individual speaker configurations. - { # 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. - }, - ], - }, - "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", - ], + "safetySettings": [ # 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. }, - }, - "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". - "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + ], + "serviceTier": "A String", # The service tier for 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset 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. # NOTE: We use these instead of the Citation message for historical reasons. 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. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, ], - "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": [ # The results of the File Search. - { # The result of the File Search. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "processingType": "A String", + "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. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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", # 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. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage, this is the Cloud Storage 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of 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 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", + ], }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "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", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "searchType": "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, + "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. + "queries": [ # Queries for Retrieval information. + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "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", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image 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. + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + "processingType": "A String", + "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", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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", }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. + ], + "widgetContextToken": "A String", }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + ], + }, + "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 text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. + "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. @@ -11332,281 +6325,20 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "processingType": "A String", + "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`. @@ -11619,101 +6351,40 @@

Method Details

"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": { # 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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. - }, - }, - ], - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. + "processingResult": { # The result of a server-initiated media processing step. }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "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. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, + "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. }, ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -11759,256 +6430,122 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # 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 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. - }, - ], + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset 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. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - }, - ], + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. }, - "processingType": "A String", - "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 ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "nullValue": "A String", # Represents a null value. - "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.). + "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. @@ -12066,493 +6603,165 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "listValue": { # `ListValue` is 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. }, }, - "processingType": "A String", - "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", # 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", ], }, - "nullValue": "A String", # Represents a null value. - "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. - }, - }, - "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. - "safetySettings": [ # 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. - }, - ], - "serviceTier": "A String", # The service tier for 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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 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", ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -12598,368 +6807,220 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + }, + "processingType": "A String", "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, + "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. + "queries": [ # Queries for Retrieval information. + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, + "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", ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. 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 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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 ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "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. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct + ], + "url": "A String", + }, + ], + "widgetContextToken": "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. - { + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -12971,876 +7032,175 @@

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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "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. # NOTE: We use these instead of the Citation message for historical reasons. 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "processingType": "A String", - "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. }, - ], - }, - "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`. + "processingResult": { # The result of a server-initiated media processing step. + }, + "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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. + }, + ], }, }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - }, - ], + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - "listValue": { # `ListValue` is 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. + "processingType": "A String", + "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. + "contentString": "A String", # The content of the step. A single 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", - ], - }, + }, + ], + "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. }, - "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. + "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", + ], }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). - }, - "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. - "queries": [ # Queries for Retrieval information. - "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. + "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. }, - "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. + "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. @@ -13900,281 +7260,20 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "processingType": "A String", + "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`. @@ -14188,467 +7287,466 @@

Method Details

"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", - }, + "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", ], }, - "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. + "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" }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "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. + "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. + "customConfig": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "ragResources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rankService": { # Config for Rank Service. # Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. + }, }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertexAiSearchConfig": { # 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. + }, + }, + ], + "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. + }, + "codeMenderConfig": { # Configuration for the CodeMender agent. + "findRequest": { # 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. + "findingId": "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. + "sourceFiles": [ # 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. + }, + ], + }, + "fixRequest": { # 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. + "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "sourceFiles": [ # 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. + "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "sessionId": "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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": [ # The results of the File Search. - { # The result of the File Search. - }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 + ], + }, + }, + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "nullValue": "A String", # Represents a null value. - "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. - }, - "processingResult": { # The result of a server-initiated media processing step. + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - "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. + "processingType": "A String", + "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. + "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. + { # Error message from an interaction. + "code": "A String", # A URI that identifies the error type. + "message": "A String", # A human-readable error message. + }, + ], + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "labels": { # 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`. }, - "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. + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "seed": 42, # Seed used in decoding for reproducibility. + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. + "speakers": [ # Individual speaker configurations. + { # 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. }, ], }, - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "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". + "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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. + }, + "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 Cloud Storage, this is the Cloud Storage path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -14694,307 +7792,173 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "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. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": { # 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "listValue": { # `ListValue` is 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. }, }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -15040,310 +8004,258 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "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. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": { # 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. + }, + }, + "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", + ], + "safetySettings": [ # 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. + }, + ], + "serviceTier": "A String", # The service tier for 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset 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. # NOTE: We use these instead of the Citation message for historical reasons. 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. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, ], - "text": "A String", # Required. The text content. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be 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 content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -15389,314 +8301,165 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. + "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 content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the 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 call step. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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. }, }, ], }, - "name": "A String", # Name of the tool which is called 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. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL 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 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", + ], + }, }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "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. }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -15742,271 +8505,69 @@

Method Details

], "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user 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. + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "listValue": { # `ListValue` is 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. }, - "processingType": "A String", - "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. }, - ], - }, - "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. + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, + "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. + "queries": [ # Queries for Retrieval information. + "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. @@ -16066,267 +8627,6 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -16354,105 +8654,52 @@

Method Details

"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. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). - }, - "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. - "queries": [ # Queries for Retrieval information. - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -16498,453 +8745,337 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "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. }, + "serverName": "A String", # The name of the used MCP server. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. + "processingResult": { # The result of a server-initiated media processing step. + }, + "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # 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. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - }, - "processingType": "A String", - "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. }, - "listValue": { # `ListValue` is 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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`. - }, + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "fileSearchCall": { # File Search content. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - "searchType": "A String", # The type of search grounding enabled. + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. - }, - ], + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, "text": { # A text content block. "annotations": [ # Citation information for model-generated content. { # Citation information for model-generated content. @@ -16984,47 +9115,73 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - ], - "url": "A String", # URI reference of the place. + }, + "processingType": "A String", + "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. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # 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 content. - "contentList": { - "contents": [ - { + }, + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -17070,299 +9227,102 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - }, - "processingType": "A String", - "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. }, - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). }, - "nullValue": "A String", # Represents a null value. - "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. - }, - "processingResult": { # The result of a server-initiated media processing step. - }, - "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. - "isError": True or False, # Whether the retrieval resulted in an error. - }, - "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. + "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. }, - ], - }, - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, + "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", ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments 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. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. @@ -17374,199 +9334,94 @@

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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - ], + "processingType": "A String", + "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 ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "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. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - }, - ], - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -17612,126 +9467,193 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "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. }, + "serverName": "A String", # The name of the used MCP server. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. + "processingResult": { # The result of a server-initiated media processing step. + }, + "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], + "processingType": "A String", + "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. - { + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -17743,86 +9665,253 @@

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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - ], + "processingType": "A String", + "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 ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "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. + }, + }, + "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. + "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. + "customConfig": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "ragResources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "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. + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rankService": { # Config for Rank Service. # Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. }, - ], + }, + "topK": 42, # Optional. The number of contexts to retrieve. }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertexAiSearchConfig": { # 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. + }, + }, + ], + "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", + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. @@ -17851,171 +9940,301 @@

Method Details

"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", - ], + "image": { + "data": "A String", + "mimeType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "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. + "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", ], }, - ], - "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. - "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "apiKey": "A String", # Required. The API key for ExaAiSearch. - "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. + "googleSearchCall": { + "arguments": { # The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, }, - "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. - "customConfig": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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", + "serverName": "A String", }, - "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "ragResources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], + "processingCall": { # Streaming delta for a server-initiated media processing step. + }, + "retrievalCall": { # Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the Retrieval tool. + "queries": [ # Queries for Retrieval information. + "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. }, ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rankService": { # Config for Rank Service. # Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. - }, + }, + "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. }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + ], }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertexAiSearchConfig": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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", + }, + "processingResult": { # Streaming delta for the result of a server-initiated media processing step. + }, + "retrievalResult": { # Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. ToolResultDelta.type + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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. + }, ], - "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. - }, - }, - ], - "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). - }, -}
-
- -
- getStream(name, includeInput=None, lastEventId=None, stream=None, x__xgafv=None) -
Fully typed proto, streaming version of GetInteraction that returns Interaction proto.
-
-Args:
-  name: string, Required. The name of the interaction to retrieve. Format: interactions/{interaction} (required)
-  includeInput: boolean, If true, includes the input in the response.
-  lastEventId: string, If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.
-  stream: boolean, If true, streams the interaction events as Server-Sent Events.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    {
-  "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.
-        "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",
-      },
-      "image": {
-        "data": "A String",
-        "mimeType": "A String",
-        "resolution": "A String", # The resolution of the media.
-        "uri": "A String",
       },
       "text": {
         "text": "A String",
       },
-      "textAnnotation": {
+      "textAnnotationDelta": {
         "annotations": [ # Citation information for model-generated content.
           { # Citation information for model-generated content.
             "endIndex": 42, # End of the attributed segment, exclusive.
@@ -18115,40494 +10334,212 @@ 

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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`. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - "fileSearchCall": { # File Search content. + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + }, + "video": { + "data": "A String", + "mimeType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", + }, + }, + "index": 42, + }, + "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. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - }, - "toolCall": { - "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": { - }, - "functionCall": { - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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", - }, - "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", - ], - }, - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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", - "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", - ], - }, - }, - }, - "toolResult": { - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { - "isError": True or False, - "result": "A String", - }, - "fileSearchResult": { - "result": [ - { # The result of the File Search. - }, - ], - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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", - }, - "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. - }, - ], - }, - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "findRequest": { # 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. - "findingId": "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. - "sourceFiles": [ # 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. - }, - ], - }, - "fixRequest": { # 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. - "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. - "sourceFiles": [ # 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. - "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. - "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. - }, - "sessionId": "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. - { # Error message from an interaction. - "code": "A String", # A URI that identifies the error type. - "message": "A String", # A human-readable error message. - }, - ], - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "labels": { # 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. - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. - "speakers": [ # Individual speaker configurations. - { # 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. - }, - ], - }, - "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". - "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage, this is the Cloud Storage 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. - }, - }, - ], - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. - }, - }, - "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. - "safetySettings": [ # 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. - }, - ], - "serviceTier": "A String", # The service tier for 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). - }, - "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. - "queries": [ # Queries for Retrieval information. - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingResult": { # The result of a server-initiated media processing step. - }, - "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. - "isError": True or False, # Whether the retrieval resulted in an error. - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). - }, - "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. - "queries": [ # Queries for Retrieval information. - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingResult": { # The result of a server-initiated media processing step. - }, - "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. - "isError": True or False, # Whether the retrieval resulted in an error. - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - }, - ], - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "apiKey": "A String", # Required. The API key for ExaAiSearch. - "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. - "customConfig": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "ragResources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rankService": { # Config for Rank Service. # Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertexAiSearchConfig": { # 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. - }, - }, - ], - "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. - "findRequest": { # 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. - "findingId": "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. - "sourceFiles": [ # 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. - }, - ], - }, - "fixRequest": { # 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. - "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. - "sourceFiles": [ # 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. - "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. - "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. - }, - "sessionId": "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. - { # Error message from an interaction. - "code": "A String", # A URI that identifies the error type. - "message": "A String", # A human-readable error message. - }, - ], - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "labels": { # 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. - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. - "speakers": [ # Individual speaker configurations. - { # 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. - }, - ], - }, - "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". - "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage, this is the Cloud Storage 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. - }, - }, - ], - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. - }, - }, - "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. - "safetySettings": [ # 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. - }, - ], - "serviceTier": "A String", # The service tier for 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). - }, - "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. - "queries": [ # Queries for Retrieval information. - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingResult": { # The result of a server-initiated media processing step. - }, - "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. - "isError": True or False, # Whether the retrieval resulted in an error. - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). - }, - "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. - "queries": [ # Queries for Retrieval information. - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingResult": { # The result of a server-initiated media processing step. - }, - "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. - "isError": True or False, # Whether the retrieval resulted in an error. - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - }, - ], - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "apiKey": "A String", # Required. The API key for ExaAiSearch. - "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. - "customConfig": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "ragResources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rankService": { # Config for Rank Service. # Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertexAiSearchConfig": { # 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. - }, - }, - ], - "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. - }, - "codeMenderConfig": { # Configuration for the CodeMender agent. - "findRequest": { # 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. - "findingId": "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. - "sourceFiles": [ # 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. - }, - ], - }, - "fixRequest": { # 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. - "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. - "sourceFiles": [ # 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. - "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. - "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. - }, - "sessionId": "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. - { # Error message from an interaction. - "code": "A String", # A URI that identifies the error type. - "message": "A String", # A human-readable error message. - }, - ], - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "labels": { # 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. - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. - "speakers": [ # Individual speaker configurations. - { # 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. - }, - ], - }, - "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". - "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage, this is the Cloud Storage 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. - }, - }, - ], - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. - }, - }, - "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. - "safetySettings": [ # 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. - }, - ], - "serviceTier": "A String", # The service tier for 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). - }, - "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. - "queries": [ # Queries for Retrieval information. - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingResult": { # The result of a server-initiated media processing step. - }, - "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. - "isError": True or False, # Whether the retrieval resulted in an error. - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). - }, - "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. - "queries": [ # Queries for Retrieval information. - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingResult": { # The result of a server-initiated media processing step. - }, - "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. - "isError": True or False, # Whether the retrieval resulted in an error. - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - }, - ], - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "apiKey": "A String", # Required. The API key for ExaAiSearch. - "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. - "customConfig": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "ragResources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rankService": { # Config for Rank Service. # Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertexAiSearchConfig": { # 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. - }, - }, - ], - "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. - "findRequest": { # 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. - "findingId": "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. - "sourceFiles": [ # 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. - }, - ], - }, - "fixRequest": { # 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. - "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. - "sourceFiles": [ # 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. - "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. - "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. - }, - "sessionId": "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. - { # Error message from an interaction. - "code": "A String", # A URI that identifies the error type. - "message": "A String", # A human-readable error message. - }, - ], - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "labels": { # 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. - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. - "speakers": [ # Individual speaker configurations. - { # 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. - }, - ], - }, - "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". - "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage, this is the Cloud Storage 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. - }, - }, - ], - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. - }, - }, - "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. - "safetySettings": [ # 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. - }, - ], - "serviceTier": "A String", # The service tier for 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). - }, - "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. - "queries": [ # Queries for Retrieval information. - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingResult": { # The result of a server-initiated media processing step. - }, - "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. - "isError": True or False, # Whether the retrieval resulted in an error. - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). - }, - "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. - "queries": [ # Queries for Retrieval information. - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingResult": { # The result of a server-initiated media processing step. - }, - "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. - "isError": True or False, # Whether the retrieval resulted in an error. - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - }, - ], - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "apiKey": "A String", # Required. The API key for ExaAiSearch. - "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. - "customConfig": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "ragResources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rankService": { # Config for Rank Service. # Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertexAiSearchConfig": { # 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. - }, - }, - ], - "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", - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - }, - "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", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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", - "serverName": "A String", - }, - "processingCall": { # Streaming delta for a server-initiated media processing step. - }, - "retrievalCall": { # Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the Retrieval tool. - "queries": [ # Queries for Retrieval information. - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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", - }, - "processingResult": { # Streaming delta for the result of a server-initiated media processing step. - }, - "retrievalResult": { # Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. ToolResultDelta.type - "isError": True or False, # Whether the retrieval resulted in an error. - }, - "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. - }, - ], - }, - }, - "text": { - "text": "A String", - }, - "textAnnotationDelta": { - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - }, - "thoughtSignature": { - "signature": "A String", # Signature to match the backend source to be part of the generation. - }, - "thoughtSummary": { - "content": { # The content of the response. # A new summary item to be added to the thought. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - }, - "video": { - "data": "A String", - "mimeType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", - }, - }, - "index": 42, - }, - "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. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "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`. - }, - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "processingType": "A String", - "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset 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. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "nullValue": "A String", # Represents a null value. - "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. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], + "processingType": "A String", + "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", @@ -58660,272 +10597,11 @@

Method Details

"endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", # The transcribed word. }, - ], - }, + }, + ], + "text": "A String", # Required. The text content. }, "video": { # A video content block. "data": "A String", # The video content. @@ -58956,103 +10632,44 @@

Method Details

}, ], }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + "name": "A String", # Required. The name of the tool to call. }, - "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. + "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", ], }, - "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. + "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. }, - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -59098,217 +10715,127 @@

Method Details

], "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, + "processingType": "A String", + "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 + "nullValue": "A String", # Represents a null value. + "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 content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL 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", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, + "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. + "queries": [ # Queries for Retrieval information. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. @@ -59414,280 +10941,19 @@

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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. 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. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. @@ -59794,267 +11060,6 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html index 072af74cfc..7463195116 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html @@ -141,7 +141,7 @@

Method Details

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

Method Details

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

Method Details

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

Method Details

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

Method Details

"headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, - "name": "A String", # Optional. The tool's GCP resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. + "name": "A String", # Optional. The tool's Google Cloud resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationExperiments.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationExperiments.html new file mode 100644 index 0000000000..30cec9d463 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationExperiments.html @@ -0,0 +1,325 @@ + + + +

Agent Platform API . projects . locations . evaluationExperiments

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates an Evaluation Experiment.

+

+ delete(name, x__xgafv=None)

+

Deletes an Evaluation Experiment.

+

+ get(name, x__xgafv=None)

+

Gets an Evaluation Experiment.

+

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

+

Lists Evaluation Experiments.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates an Evaluation Experiment.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an Evaluation Experiment.
+
+Args:
+  parent: string, Required. The resource name of the Location to create the Evaluation Experiment in. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # EvaluationExperiment is a resource that represents an experiment for iterating on and visualizing evaluation runs.
+  "createTime": "A String", # Output only. Timestamp when this experiment was created.
+  "displayName": "A String", # Required. The display name of the evaluation experiment.
+  "evaluationRuns": [ # Required. The EvaluationRuns that are part of this experiment.
+    "A String",
+  ],
+  "labels": { # Optional. Labels for the evaluation experiment.
+    "a_key": "A String",
+  },
+  "metadata": { # Optional. Metadata about the evaluation experiment, can be used by the caller to store additional tracking information about the experiment.
+    "a_key": "", # Properties of the object.
+  },
+  "name": "A String", # Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`
+  "updateTime": "A String", # Output only. Timestamp when this experiment 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:
+
+    { # EvaluationExperiment is a resource that represents an experiment for iterating on and visualizing evaluation runs.
+  "createTime": "A String", # Output only. Timestamp when this experiment was created.
+  "displayName": "A String", # Required. The display name of the evaluation experiment.
+  "evaluationRuns": [ # Required. The EvaluationRuns that are part of this experiment.
+    "A String",
+  ],
+  "labels": { # Optional. Labels for the evaluation experiment.
+    "a_key": "A String",
+  },
+  "metadata": { # Optional. Metadata about the evaluation experiment, can be used by the caller to store additional tracking information about the experiment.
+    "a_key": "", # Properties of the object.
+  },
+  "name": "A String", # Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`
+  "updateTime": "A String", # Output only. Timestamp when this experiment was last updated.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an Evaluation Experiment.
+
+Args:
+  name: string, Required. The name of the EvaluationExperiment resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets an Evaluation Experiment.
+
+Args:
+  name: string, Required. The name of the EvaluationExperiment resource. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # EvaluationExperiment is a resource that represents an experiment for iterating on and visualizing evaluation runs.
+  "createTime": "A String", # Output only. Timestamp when this experiment was created.
+  "displayName": "A String", # Required. The display name of the evaluation experiment.
+  "evaluationRuns": [ # Required. The EvaluationRuns that are part of this experiment.
+    "A String",
+  ],
+  "labels": { # Optional. Labels for the evaluation experiment.
+    "a_key": "A String",
+  },
+  "metadata": { # Optional. Metadata about the evaluation experiment, can be used by the caller to store additional tracking information about the experiment.
+    "a_key": "", # Properties of the object.
+  },
+  "name": "A String", # Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`
+  "updateTime": "A String", # Output only. Timestamp when this experiment was last updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Evaluation Experiments.
+
+Args:
+  parent: string, Required. The resource name of the Location from which to list the Evaluation Experiments. Format: `projects/{project}/locations/{location}` (required)
+  filter: string, Optional. Filter expression that matches a subset of the EvaluationExperiments to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.
+  pageSize: integer, Optional. The maximum number of Evaluation Experiments to return.
+  pageToken: string, Optional. A page token, received from a previous `ListEvaluationExperiments` 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 EvaluationManagementService.ListEvaluationExperiments.
+  "evaluationExperiments": [ # List of EvaluationExperiments in the requested page.
+    { # EvaluationExperiment is a resource that represents an experiment for iterating on and visualizing evaluation runs.
+      "createTime": "A String", # Output only. Timestamp when this experiment was created.
+      "displayName": "A String", # Required. The display name of the evaluation experiment.
+      "evaluationRuns": [ # Required. The EvaluationRuns that are part of this experiment.
+        "A String",
+      ],
+      "labels": { # Optional. Labels for the evaluation experiment.
+        "a_key": "A String",
+      },
+      "metadata": { # Optional. Metadata about the evaluation experiment, can be used by the caller to store additional tracking information about the experiment.
+        "a_key": "", # Properties of the object.
+      },
+      "name": "A String", # Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`
+      "updateTime": "A String", # Output only. Timestamp when this experiment was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results.
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates an Evaluation Experiment.
+
+Args:
+  name: string, Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # EvaluationExperiment is a resource that represents an experiment for iterating on and visualizing evaluation runs.
+  "createTime": "A String", # Output only. Timestamp when this experiment was created.
+  "displayName": "A String", # Required. The display name of the evaluation experiment.
+  "evaluationRuns": [ # Required. The EvaluationRuns that are part of this experiment.
+    "A String",
+  ],
+  "labels": { # Optional. Labels for the evaluation experiment.
+    "a_key": "A String",
+  },
+  "metadata": { # Optional. Metadata about the evaluation experiment, can be used by the caller to store additional tracking information about the experiment.
+    "a_key": "", # Properties of the object.
+  },
+  "name": "A String", # Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`
+  "updateTime": "A String", # Output only. Timestamp when this experiment was last updated.
+}
+
+  updateMask: string, Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # EvaluationExperiment is a resource that represents an experiment for iterating on and visualizing evaluation runs.
+  "createTime": "A String", # Output only. Timestamp when this experiment was created.
+  "displayName": "A String", # Required. The display name of the evaluation experiment.
+  "evaluationRuns": [ # Required. The EvaluationRuns that are part of this experiment.
+    "A String",
+  ],
+  "labels": { # Optional. Labels for the evaluation experiment.
+    "a_key": "A String",
+  },
+  "metadata": { # Optional. Metadata about the evaluation experiment, can be used by the caller to store additional tracking information about the experiment.
+    "a_key": "", # Properties of the object.
+  },
+  "name": "A String", # Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`
+  "updateTime": "A String", # Output only. Timestamp when this experiment was last updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html index 4bc5dd0163..2a863faade 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html @@ -1750,6 +1750,7 @@

Method Details

}, ], }, + "evaluationExperiment": "A String", # Optional. The resource name of the evaluation experiment for the evaluation run. Setting the evaluation experiment will add the run to the experiment. Multiple runs can be added to the same experiment. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}` "evaluationResults": { # The results of the evaluation run. # Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED. "evaluationSet": "A String", # The evaluation set where item level results are stored. "lossAnalysisResults": [ # Output only. The results of the auto-loss analysis performed on the eval set associated with the run. @@ -4291,6 +4292,9 @@

Method Details

}, "agentRunConfig": { # Configuration for Agent Run. # Optional. Agent run config. "agentEngine": "A String", # Optional. The resource name of the Agent Engine. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine} For example: projects/123/locations/us-central1/reasoningEngines/456 + "discoveryEngineAssistantConfig": { # Config for scraping a Discovery Engine Assistant. # Optional. Config for scraping a Discovery Engine Assistant. The scraping service runs the assistant via the Discovery Engine AssistantService and returns the resulting trajectory for evaluation. + "assistant": "A String", # Required. The resource name of the Discovery Engine Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`. For example: `projects/123/locations/global/collections/default_collection/engines/my-engine/assistants/default_assistant`. + }, "geminiAgentConfig": { # Config for scraping a Gemini Agent (a Vertex AI Agent resource scraped via the Vertex Interactions API). # Optional. Config for scraping a Gemini Agent via the Interactions API. The scraping service creates interactions against the agent and returns the resulting interaction traces for evaluation. "geminiAgent": "A String", # Required. The resource name of the Gemini Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. For example: `projects/123/locations/us-central1/agents/my-agent`. }, @@ -6527,6 +6531,7 @@

Method Details

}, ], }, + "evaluationExperiment": "A String", # Optional. The resource name of the evaluation experiment for the evaluation run. Setting the evaluation experiment will add the run to the experiment. Multiple runs can be added to the same experiment. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}` "evaluationResults": { # The results of the evaluation run. # Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED. "evaluationSet": "A String", # The evaluation set where item level results are stored. "lossAnalysisResults": [ # Output only. The results of the auto-loss analysis performed on the eval set associated with the run. @@ -9068,6 +9073,9 @@

Method Details

}, "agentRunConfig": { # Configuration for Agent Run. # Optional. Agent run config. "agentEngine": "A String", # Optional. The resource name of the Agent Engine. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine} For example: projects/123/locations/us-central1/reasoningEngines/456 + "discoveryEngineAssistantConfig": { # Config for scraping a Discovery Engine Assistant. # Optional. Config for scraping a Discovery Engine Assistant. The scraping service runs the assistant via the Discovery Engine AssistantService and returns the resulting trajectory for evaluation. + "assistant": "A String", # Required. The resource name of the Discovery Engine Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`. For example: `projects/123/locations/global/collections/default_collection/engines/my-engine/assistants/default_assistant`. + }, "geminiAgentConfig": { # Config for scraping a Gemini Agent (a Vertex AI Agent resource scraped via the Vertex Interactions API). # Optional. Config for scraping a Gemini Agent via the Interactions API. The scraping service creates interactions against the agent and returns the resulting interaction traces for evaluation. "geminiAgent": "A String", # Required. The resource name of the Gemini Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. For example: `projects/123/locations/us-central1/agents/my-agent`. }, @@ -11346,6 +11354,7 @@

Method Details

}, ], }, + "evaluationExperiment": "A String", # Optional. The resource name of the evaluation experiment for the evaluation run. Setting the evaluation experiment will add the run to the experiment. Multiple runs can be added to the same experiment. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}` "evaluationResults": { # The results of the evaluation run. # Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED. "evaluationSet": "A String", # The evaluation set where item level results are stored. "lossAnalysisResults": [ # Output only. The results of the auto-loss analysis performed on the eval set associated with the run. @@ -13887,6 +13896,9 @@

Method Details

}, "agentRunConfig": { # Configuration for Agent Run. # Optional. Agent run config. "agentEngine": "A String", # Optional. The resource name of the Agent Engine. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine} For example: projects/123/locations/us-central1/reasoningEngines/456 + "discoveryEngineAssistantConfig": { # Config for scraping a Discovery Engine Assistant. # Optional. Config for scraping a Discovery Engine Assistant. The scraping service runs the assistant via the Discovery Engine AssistantService and returns the resulting trajectory for evaluation. + "assistant": "A String", # Required. The resource name of the Discovery Engine Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`. For example: `projects/123/locations/global/collections/default_collection/engines/my-engine/assistants/default_assistant`. + }, "geminiAgentConfig": { # Config for scraping a Gemini Agent (a Vertex AI Agent resource scraped via the Vertex Interactions API). # Optional. Config for scraping a Gemini Agent via the Interactions API. The scraping service creates interactions against the agent and returns the resulting interaction traces for evaluation. "geminiAgent": "A String", # Required. The resource name of the Gemini Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. For example: `projects/123/locations/us-central1/agents/my-agent`. }, @@ -16136,6 +16148,7 @@

Method Details

}, ], }, + "evaluationExperiment": "A String", # Optional. The resource name of the evaluation experiment for the evaluation run. Setting the evaluation experiment will add the run to the experiment. Multiple runs can be added to the same experiment. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}` "evaluationResults": { # The results of the evaluation run. # Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED. "evaluationSet": "A String", # The evaluation set where item level results are stored. "lossAnalysisResults": [ # Output only. The results of the auto-loss analysis performed on the eval set associated with the run. @@ -18677,6 +18690,9 @@

Method Details

}, "agentRunConfig": { # Configuration for Agent Run. # Optional. Agent run config. "agentEngine": "A String", # Optional. The resource name of the Agent Engine. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine} For example: projects/123/locations/us-central1/reasoningEngines/456 + "discoveryEngineAssistantConfig": { # Config for scraping a Discovery Engine Assistant. # Optional. Config for scraping a Discovery Engine Assistant. The scraping service runs the assistant via the Discovery Engine AssistantService and returns the resulting trajectory for evaluation. + "assistant": "A String", # Required. The resource name of the Discovery Engine Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`. For example: `projects/123/locations/global/collections/default_collection/engines/my-engine/assistants/default_assistant`. + }, "geminiAgentConfig": { # Config for scraping a Gemini Agent (a Vertex AI Agent resource scraped via the Vertex Interactions API). # Optional. Config for scraping a Gemini Agent via the Interactions API. The scraping service creates interactions against the agent and returns the resulting interaction traces for evaluation. "geminiAgent": "A String", # Required. The resource name of the Gemini Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. For example: `projects/123/locations/us-central1/agents/my-agent`. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index 439b176703..e0c99482de 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -129,6 +129,11 @@

Instance Methods

Returns the endpoints Resource.

+

+ evaluationExperiments() +

+

Returns the evaluationExperiments Resource.

+

evaluationItems()

diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html index 5d00f7dd5a..c9163f2ac1 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html @@ -210,267 +210,6 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -560,347 +299,361 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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`. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - "fileSearchCall": { # File Search content. + "processingType": "A String", + "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. + "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. + { # Error message from an interaction. + "code": "A String", # A URI that identifies the error type. + "message": "A String", # A human-readable error message. + }, + ], + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "labels": { # 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`. }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "seed": 42, # Seed used in decoding for reproducibility. + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. + "speakers": [ # Individual speaker configurations. + { # 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. + }, + ], }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. + "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", ], }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + "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". + "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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", + ], }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "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. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. + "model": "A String", # The name of the `Model` used for generating the completion. + }, + "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", }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 + ], + }, + "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 Cloud Storage, this is the Cloud Storage path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "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. + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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. }, }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL 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": { # 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. }, }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -946,837 +699,584 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "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. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": { # 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "listValue": { # `ListValue` is 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. }, }, - "processingType": "A String", - "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. - "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. - { # Error message from an interaction. - "code": "A String", # A URI that identifies the error type. - "message": "A String", # A human-readable error message. }, - ], - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "labels": { # 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. - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. - "speakers": [ # Individual speaker configurations. - { # 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. - }, - ], - }, - "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". - "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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. - }, + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "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", + ], + "safetySettings": [ # 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. + }, + ], + "serviceTier": "A String", # The service tier for 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], - "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": [ # The results of the File Search. - { # The result of the File Search. + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of 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 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "processingType": "A String", + "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. + "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`. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. # NOTE: We use these instead of the Citation message for historical reasons. 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage, this is the Cloud Storage 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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", # Required. The name of the tool to call. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "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", + ], + }, }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "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. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, + "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. + "queries": [ # Queries for Retrieval information. + "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", + ], + }, + }, }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -1822,47 +1322,79 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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", }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -1908,1389 +1440,462 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "serverName": "A String", # The name of the used MCP server. + }, + "processingResult": { # The result of a server-initiated media processing step. + }, + "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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. + }, + ], }, }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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`. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. # NOTE: We use these instead of the Citation message for historical reasons. 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - }, - ], - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - "listValue": { # `ListValue` is 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. + "processingType": "A String", + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. + "contentString": "A String", # The content of the step. A single 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. - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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`. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset 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. + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset 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. + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # 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. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, + "listValue": { # `ListValue` is 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. }, - "processingType": "A String", - "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. }, - ], - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. @@ -3302,145 +1907,86 @@

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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "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. # NOTE: We use these instead of the Citation message for historical reasons. 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. + }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, + "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. + "queries": [ # Queries for Retrieval information. + "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", + ], + }, + }, }, - }, - "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. - }, - }, - "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. - "safetySettings": [ # 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. - }, - ], - "serviceTier": "A String", # The service tier for 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. + "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. @@ -3498,276 +2044,133 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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", + }, + ], + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, "processingType": "A String", @@ -3775,20 +2178,37 @@

Method Details

"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. + "listValue": { # `ListValue` is 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. }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. + "processingResult": { # The result of a server-initiated media processing step. + }, + "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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. @@ -3847,50525 +2267,597 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, + "processingType": "A String", + "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "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`. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "fileSearchCall": { # File Search call step. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. + "nullValue": "A String", # Represents a null value. + "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", + ], }, - "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", - ], - }, + ], + "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. + "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). - }, - "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. - "queries": [ # Queries for Retrieval information. - "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. + }, + "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. + "customConfig": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "ragResources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. "A String", ], }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rankService": { # Config for Rank Service. # Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingResult": { # The result of a server-initiated media processing step. - }, - "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. - "isError": True or False, # Whether the retrieval resulted in an error. - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). - }, - "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. - "queries": [ # Queries for Retrieval information. - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingResult": { # The result of a server-initiated media processing step. - }, - "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. - "isError": True or False, # Whether the retrieval resulted in an error. - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - }, - ], - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "apiKey": "A String", # Required. The API key for ExaAiSearch. - "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. - "customConfig": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "ragResources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rankService": { # Config for Rank Service. # Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertexAiSearchConfig": { # 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. - }, - }, - ], - "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). - }, - }, - "store": True or False, # Input only. Whether to store the response and request for later retrieval. - "stream": True or False, # Input only. Whether the interaction will be streamed. -} - - x__xgafv: string, V1 error format. - Allowed values - 1 - v1 error format - 2 - v2 error format - -Returns: - An object of the form: - - { # 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. - "findRequest": { # 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. - "findingId": "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. - "sourceFiles": [ # 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. - }, - ], - }, - "fixRequest": { # 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. - "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. - "sourceFiles": [ # 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. - "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. - "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. - }, - "sessionId": "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. - { # Error message from an interaction. - "code": "A String", # A URI that identifies the error type. - "message": "A String", # A human-readable error message. - }, - ], - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "labels": { # 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. - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. - "speakers": [ # Individual speaker configurations. - { # 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. - }, - ], - }, - "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". - "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage, this is the Cloud Storage 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. - }, - }, - ], - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. - }, - }, - "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. - "safetySettings": [ # 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. - }, - ], - "serviceTier": "A String", # The service tier for 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). - }, - "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. - "queries": [ # Queries for Retrieval information. - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingResult": { # The result of a server-initiated media processing step. - }, - "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. - "isError": True or False, # Whether the retrieval resulted in an error. - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). - }, - "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. - "queries": [ # Queries for Retrieval information. - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - "processingResult": { # The result of a server-initiated media processing step. - }, - "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. - "isError": True or False, # Whether the retrieval resulted in an error. - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - }, - }, - ], - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "apiKey": "A String", # Required. The API key for ExaAiSearch. - "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. - "customConfig": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "ragResources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rankService": { # Config for Rank Service. # Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. - }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertexAiSearchConfig": { # 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. - }, - }, - ], - "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). - }, -}
-
- -
- createStream(projectsId, locationsId, body=None, x__xgafv=None) -
Creates an interaction and streams the response.
-
-Args:
-  projectsId: string, A parameter (required)
-  locationsId: string, A parameter (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Configuration parameters for creating an interaction.
-  "background": True or False, # Input only. Whether to run the model interaction in the background.
-  "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.
-        "findRequest": { # 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.
-          "findingId": "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.
-          "sourceFiles": [ # 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.
-            },
-          ],
-        },
-        "fixRequest": { # 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.
-          "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability.
-          "sourceFiles": [ # 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.
-        "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior.
-          "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout.
-        },
-        "sessionId": "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-        "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-        "sampleRate": 42, # The sample rate of the audio.
-        "uri": "A String", # The URI of the audio.
-      },
-      "document": { # A document content block.
-        "data": "A String", # The document content.
-        "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-        "uri": "A String", # The URI of the document.
-      },
-      "image": { # An image content block.
-        "data": "A String", # The image content.
-        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-        "resolution": "A String", # The resolution of the media.
-        "uri": "A String", # The URI of the image.
-      },
-      "text": { # A text content block.
-        "annotations": [ # Citation information for model-generated content.
-          { # Citation information for model-generated content.
-            "endIndex": 42, # End of the attributed segment, exclusive.
-            "fileCitation": { # A file citation annotation. # A file citation annotation.
-              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-              "documentUri": "A String", # The URI of the file.
-              "fileName": "A String", # The name of the file.
-              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-              "pageNumber": 42, # Page number of the cited document, if applicable.
-              "source": "A String", # Source attributed for a portion of the text.
-            },
-            "placeCitation": { # A place citation annotation. # A place citation annotation.
-              "name": "A String", # Title of the place.
-              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                  "reviewId": "A String", # The ID of the review snippet.
-                  "title": "A String", # Title of the review.
-                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                },
-              ],
-              "url": "A String", # URI reference of the place.
-            },
-            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-              "title": "A String", # The title of the URL.
-              "url": "A String", # The URL.
-            },
-            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-              "startOffset": "A String", # Start offset in time of the word relative to 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.
-              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-              "resolution": "A String", # The resolution of the media.
-              "uri": "A String", # The URI of the image.
-            },
-            "text": { # A text content block.
-              "annotations": [ # Citation information for model-generated content.
-                { # Citation information for model-generated content.
-                  "endIndex": 42, # End of the attributed segment, exclusive.
-                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                    "documentUri": "A String", # The URI of the file.
-                    "fileName": "A String", # The name of the file.
-                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                    "source": "A String", # Source attributed for a portion of the text.
-                  },
-                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                    "name": "A String", # Title of the place.
-                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                        "reviewId": "A String", # The ID of the review snippet.
-                        "title": "A String", # Title of the review.
-                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                      },
-                    ],
-                    "url": "A String", # URI reference of the place.
-                  },
-                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                    "title": "A String", # The title of the URL.
-                    "url": "A String", # The URL.
-                  },
-                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                    "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-            { # The result of the File Search.
-            },
-          ],
-        },
-        "functionResult": { # A function tool result content block.
-          "contentList": {
-            "contents": [
-              {
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-        "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-        "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-        "processingConfig": {
-          "static": {
-            "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-            "fps": 3.14, # Optional. Video frame-rate sampling density.
-            "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-          },
-        },
-        "processingType": "A String",
-        "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.
-            "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "sampleRate": 42, # The sample rate of the audio.
-            "uri": "A String", # The URI of the audio.
-          },
-          "document": { # A document content block.
-            "data": "A String", # The document content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "uri": "A String", # The URI of the document.
-          },
-          "image": { # An image content block.
-            "data": "A String", # The image content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "resolution": "A String", # The resolution of the media.
-            "uri": "A String", # The URI of the image.
-          },
-          "text": { # A text content block.
-            "annotations": [ # Citation information for model-generated content.
-              { # Citation information for model-generated content.
-                "endIndex": 42, # End of the attributed segment, exclusive.
-                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                  "documentUri": "A String", # The URI of the file.
-                  "fileName": "A String", # The name of the file.
-                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                  "source": "A String", # Source attributed for a portion of the text.
-                },
-                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                  "name": "A String", # Title of the place.
-                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                      "reviewId": "A String", # The ID of the review snippet.
-                      "title": "A String", # Title of the review.
-                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                    },
-                  ],
-                  "url": "A String", # URI reference of the place.
-                },
-                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                  "title": "A String", # The title of the URL.
-                  "url": "A String", # The URL.
-                },
-                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                { # The result of the File Search.
-                },
-              ],
-            },
-            "functionResult": { # A function tool result content block.
-              "contentList": {
-                "contents": [
-                  {
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-            "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-            "processingConfig": {
-              "static": {
-                "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                "fps": 3.14, # Optional. Video frame-rate sampling density.
-                "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-              },
-            },
-            "processingType": "A String",
-            "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.
-    "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction.
-      { # Error message from an interaction.
-        "code": "A String", # A URI that identifies the error type.
-        "message": "A String", # A human-readable error message.
-      },
-    ],
-    "id": "A String", # Required. Output only. A unique identifier for the interaction completion.
-    "labels": { # 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.
-        "stopSequences": [ # A list of character sequences that will stop output interaction.
-          "A String",
-        ],
-        "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration.
-          "speakers": [ # Individual speaker configurations.
-            { # 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.
-            },
-          ],
-        },
-        "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".
-          "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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.
-          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "sampleRate": 42, # The sample rate of the audio.
-          "uri": "A String", # The URI of the audio.
-        },
-        "document": { # A document content block.
-          "data": "A String", # The document content.
-          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "uri": "A String", # The URI of the document.
-        },
-        "image": { # An image content block.
-          "data": "A String", # The image content.
-          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "resolution": "A String", # The resolution of the media.
-          "uri": "A String", # The URI of the image.
-        },
-        "text": { # A text content block.
-          "annotations": [ # Citation information for model-generated content.
-            { # Citation information for model-generated content.
-              "endIndex": 42, # End of the attributed segment, exclusive.
-              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                "documentUri": "A String", # The URI of the file.
-                "fileName": "A String", # The name of the file.
-                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                "pageNumber": 42, # Page number of the cited document, if applicable.
-                "source": "A String", # Source attributed for a portion of the text.
-              },
-              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                "name": "A String", # Title of the place.
-                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                    "reviewId": "A String", # The ID of the review snippet.
-                    "title": "A String", # Title of the review.
-                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                  },
-                ],
-                "url": "A String", # URI reference of the place.
-              },
-              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                "title": "A String", # The title of the URL.
-                "url": "A String", # The URL.
-              },
-              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "resolution": "A String", # The resolution of the media.
-                "uri": "A String", # The URI of the image.
-              },
-              "text": { # A text content block.
-                "annotations": [ # Citation information for model-generated content.
-                  { # Citation information for model-generated content.
-                    "endIndex": 42, # End of the attributed segment, exclusive.
-                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                      "documentUri": "A String", # The URI of the file.
-                      "fileName": "A String", # The name of the file.
-                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                      "source": "A String", # Source attributed for a portion of the text.
-                    },
-                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                      "name": "A String", # Title of the place.
-                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                          "reviewId": "A String", # The ID of the review snippet.
-                          "title": "A String", # Title of the review.
-                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                        },
-                      ],
-                      "url": "A String", # URI reference of the place.
-                    },
-                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                      "title": "A String", # The title of the URL.
-                      "url": "A String", # The URL.
-                    },
-                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                      "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-              { # The result of the File Search.
-              },
-            ],
-          },
-          "functionResult": { # A function tool result content block.
-            "contentList": {
-              "contents": [
-                {
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-          "processingConfig": {
-            "static": {
-              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-              "fps": 3.14, # Optional. Video frame-rate sampling density.
-              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-            },
-          },
-          "processingType": "A String",
-          "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 Cloud Storage, this is the Cloud Storage 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.
-          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "sampleRate": 42, # The sample rate of the audio.
-          "uri": "A String", # The URI of the audio.
-        },
-        "document": { # A document content block.
-          "data": "A String", # The document content.
-          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "uri": "A String", # The URI of the document.
-        },
-        "image": { # An image content block.
-          "data": "A String", # The image content.
-          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "resolution": "A String", # The resolution of the media.
-          "uri": "A String", # The URI of the image.
-        },
-        "text": { # A text content block.
-          "annotations": [ # Citation information for model-generated content.
-            { # Citation information for model-generated content.
-              "endIndex": 42, # End of the attributed segment, exclusive.
-              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                "documentUri": "A String", # The URI of the file.
-                "fileName": "A String", # The name of the file.
-                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                "pageNumber": 42, # Page number of the cited document, if applicable.
-                "source": "A String", # Source attributed for a portion of the text.
-              },
-              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                "name": "A String", # Title of the place.
-                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                    "reviewId": "A String", # The ID of the review snippet.
-                    "title": "A String", # Title of the review.
-                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                  },
-                ],
-                "url": "A String", # URI reference of the place.
-              },
-              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                "title": "A String", # The title of the URL.
-                "url": "A String", # The URL.
-              },
-              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "resolution": "A String", # The resolution of the media.
-                "uri": "A String", # The URI of the image.
-              },
-              "text": { # A text content block.
-                "annotations": [ # Citation information for model-generated content.
-                  { # Citation information for model-generated content.
-                    "endIndex": 42, # End of the attributed segment, exclusive.
-                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                      "documentUri": "A String", # The URI of the file.
-                      "fileName": "A String", # The name of the file.
-                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                      "source": "A String", # Source attributed for a portion of the text.
-                    },
-                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                      "name": "A String", # Title of the place.
-                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                          "reviewId": "A String", # The ID of the review snippet.
-                          "title": "A String", # Title of the review.
-                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                        },
-                      ],
-                      "url": "A String", # URI reference of the place.
-                    },
-                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                      "title": "A String", # The title of the URL.
-                      "url": "A String", # The URL.
-                    },
-                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                      "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-              { # The result of the File Search.
-              },
-            ],
-          },
-          "functionResult": { # A function tool result content block.
-            "contentList": {
-              "contents": [
-                {
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-          "processingConfig": {
-            "static": {
-              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-              "fps": 3.14, # Optional. Video frame-rate sampling density.
-              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-            },
-          },
-          "processingType": "A String",
-          "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "sampleRate": 42, # The sample rate of the audio.
-                        "uri": "A String", # The URI of the audio.
-                      },
-                      "document": { # A document content block.
-                        "data": "A String", # The document content.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "uri": "A String", # The URI of the document.
-                      },
-                      "image": { # An image content block.
-                        "data": "A String", # The image content.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                            { # The result of the File Search.
-                            },
-                          ],
-                        },
-                        "functionResult": { # A function tool result content block.
-                          "contentList": {
-                            "contents": [
-                              {
-                                "image": { # An image content block.
-                                  "data": "A String", # The image content.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                        "processingConfig": {
-                          "static": {
-                            "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                            "fps": 3.14, # Optional. Video frame-rate sampling density.
-                            "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                          },
-                        },
-                        "processingType": "A String",
-                        "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI.
-            "resolution": "A String", # The video output resolution. Defaults to 720p.
-          },
-        },
-      ],
-    },
-    "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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "sampleRate": 42, # The sample rate of the audio.
-                  "uri": "A String", # The URI of the audio.
-                },
-                "document": { # A document content block.
-                  "data": "A String", # The document content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "uri": "A String", # The URI of the document.
-                },
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                      { # The result of the File Search.
-                      },
-                    ],
-                  },
-                  "functionResult": { # A function tool result content block.
-                    "contentList": {
-                      "contents": [
-                        {
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                  "processingConfig": {
-                    "static": {
-                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                      "fps": 3.14, # Optional. Video frame-rate sampling density.
-                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                    },
-                  },
-                  "processingType": "A String",
-                  "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI.
-        "resolution": "A String", # The video output resolution. Defaults to 720p.
-      },
-    },
-    "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.
-    "safetySettings": [ # 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.
-      },
-    ],
-    "serviceTier": "A String", # The service tier for 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "sampleRate": 42, # The sample rate of the audio.
-                  "uri": "A String", # The URI of the audio.
-                },
-                "document": { # A document content block.
-                  "data": "A String", # The document content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "uri": "A String", # The URI of the document.
-                },
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                      { # The result of the File Search.
-                      },
-                    ],
-                  },
-                  "functionResult": { # A function tool result content block.
-                    "contentList": {
-                      "contents": [
-                        {
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                  "processingConfig": {
-                    "static": {
-                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                      "fps": 3.14, # Optional. Video frame-rate sampling density.
-                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                    },
-                  },
-                  "processingType": "A String",
-                  "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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "sampleRate": 42, # The sample rate of the audio.
-                  "uri": "A String", # The URI of the audio.
-                },
-                "document": { # A document content block.
-                  "data": "A String", # The document content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "uri": "A String", # The URI of the document.
-                },
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                      { # The result of the File Search.
-                      },
-                    ],
-                  },
-                  "functionResult": { # A function tool result content block.
-                    "contentList": {
-                      "contents": [
-                        {
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                  "processingConfig": {
-                    "static": {
-                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                      "fps": 3.14, # Optional. Video frame-rate sampling density.
-                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                    },
-                  },
-                  "processingType": "A String",
-                  "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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "sampleRate": 42, # The sample rate of the audio.
-                          "uri": "A String", # The URI of the audio.
-                        },
-                        "document": { # A document content block.
-                          "data": "A String", # The document content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "uri": "A String", # The URI of the document.
-                        },
-                        "image": { # An image content block.
-                          "data": "A String", # The image content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                              { # The result of the File Search.
-                              },
-                            ],
-                          },
-                          "functionResult": { # A function tool result content block.
-                            "contentList": {
-                              "contents": [
-                                {
-                                  "image": { # An image content block.
-                                    "data": "A String", # The image content.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                          "processingConfig": {
-                            "static": {
-                              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                              "fps": 3.14, # Optional. Video frame-rate sampling density.
-                              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                            },
-                          },
-                          "processingType": "A String",
-                          "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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "sampleRate": 42, # The sample rate of the audio.
-                          "uri": "A String", # The URI of the audio.
-                        },
-                        "document": { # A document content block.
-                          "data": "A String", # The document content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "uri": "A String", # The URI of the document.
-                        },
-                        "image": { # An image content block.
-                          "data": "A String", # The image content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                              { # The result of the File Search.
-                              },
-                            ],
-                          },
-                          "functionResult": { # A function tool result content block.
-                            "contentList": {
-                              "contents": [
-                                {
-                                  "image": { # An image content block.
-                                    "data": "A String", # The image content.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                          "processingConfig": {
-                            "static": {
-                              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                              "fps": 3.14, # Optional. Video frame-rate sampling density.
-                              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                            },
-                          },
-                          "processingType": "A String",
-                          "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.
-            },
-            "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding).
-            },
-            "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.
-              "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool.
-                "queries": [ # Queries for Retrieval information.
-                  "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-            },
-            "processingResult": { # The result of a server-initiated media processing step.
-            },
-            "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.
-              "isError": True or False, # Whether the retrieval resulted in an error.
-            },
-            "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-                "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "sampleRate": 42, # The sample rate of the audio.
-                "uri": "A String", # The URI of the audio.
-              },
-              "document": { # A document content block.
-                "data": "A String", # The document content.
-                "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "uri": "A String", # The URI of the document.
-              },
-              "image": { # An image content block.
-                "data": "A String", # The image content.
-                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "resolution": "A String", # The resolution of the media.
-                "uri": "A String", # The URI of the image.
-              },
-              "text": { # A text content block.
-                "annotations": [ # Citation information for model-generated content.
-                  { # Citation information for model-generated content.
-                    "endIndex": 42, # End of the attributed segment, exclusive.
-                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                      "documentUri": "A String", # The URI of the file.
-                      "fileName": "A String", # The name of the file.
-                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                      "source": "A String", # Source attributed for a portion of the text.
-                    },
-                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                      "name": "A String", # Title of the place.
-                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                          "reviewId": "A String", # The ID of the review snippet.
-                          "title": "A String", # Title of the review.
-                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                        },
-                      ],
-                      "url": "A String", # URI reference of the place.
-                    },
-                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                      "title": "A String", # The title of the URL.
-                      "url": "A String", # The URL.
-                    },
-                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                    { # The result of the File Search.
-                    },
-                  ],
-                },
-                "functionResult": { # A function tool result content block.
-                  "contentList": {
-                    "contents": [
-                      {
-                        "image": { # An image content block.
-                          "data": "A String", # The image content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                "processingConfig": {
-                  "static": {
-                    "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                    "fps": 3.14, # Optional. Video frame-rate sampling density.
-                    "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                  },
-                },
-                "processingType": "A String",
-                "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.
-                "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "sampleRate": 42, # The sample rate of the audio.
-                "uri": "A String", # The URI of the audio.
-              },
-              "document": { # A document content block.
-                "data": "A String", # The document content.
-                "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "uri": "A String", # The URI of the document.
-              },
-              "image": { # An image content block.
-                "data": "A String", # The image content.
-                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "resolution": "A String", # The resolution of the media.
-                "uri": "A String", # The URI of the image.
-              },
-              "text": { # A text content block.
-                "annotations": [ # Citation information for model-generated content.
-                  { # Citation information for model-generated content.
-                    "endIndex": 42, # End of the attributed segment, exclusive.
-                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                      "documentUri": "A String", # The URI of the file.
-                      "fileName": "A String", # The name of the file.
-                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                      "source": "A String", # Source attributed for a portion of the text.
-                    },
-                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                      "name": "A String", # Title of the place.
-                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                          "reviewId": "A String", # The ID of the review snippet.
-                          "title": "A String", # Title of the review.
-                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                        },
-                      ],
-                      "url": "A String", # URI reference of the place.
-                    },
-                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                      "title": "A String", # The title of the URL.
-                      "url": "A String", # The URL.
-                    },
-                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                    { # The result of the File Search.
-                    },
-                  ],
-                },
-                "functionResult": { # A function tool result content block.
-                  "contentList": {
-                    "contents": [
-                      {
-                        "image": { # An image content block.
-                          "data": "A String", # The image content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                "processingConfig": {
-                  "static": {
-                    "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                    "fps": 3.14, # Optional. Video frame-rate sampling density.
-                    "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                  },
-                },
-                "processingType": "A String",
-                "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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "sampleRate": 42, # The sample rate of the audio.
-                        "uri": "A String", # The URI of the audio.
-                      },
-                      "document": { # A document content block.
-                        "data": "A String", # The document content.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "uri": "A String", # The URI of the document.
-                      },
-                      "image": { # An image content block.
-                        "data": "A String", # The image content.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                            { # The result of the File Search.
-                            },
-                          ],
-                        },
-                        "functionResult": { # A function tool result content block.
-                          "contentList": {
-                            "contents": [
-                              {
-                                "image": { # An image content block.
-                                  "data": "A String", # The image content.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                        "processingConfig": {
-                          "static": {
-                            "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                            "fps": 3.14, # Optional. Video frame-rate sampling density.
-                            "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                          },
-                        },
-                        "processingType": "A String",
-                        "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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "sampleRate": 42, # The sample rate of the audio.
-                        "uri": "A String", # The URI of the audio.
-                      },
-                      "document": { # A document content block.
-                        "data": "A String", # The document content.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "uri": "A String", # The URI of the document.
-                      },
-                      "image": { # An image content block.
-                        "data": "A String", # The image content.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                            { # The result of the File Search.
-                            },
-                          ],
-                        },
-                        "functionResult": { # A function tool result content block.
-                          "contentList": {
-                            "contents": [
-                              {
-                                "image": { # An image content block.
-                                  "data": "A String", # The image content.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                        "processingConfig": {
-                          "static": {
-                            "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                            "fps": 3.14, # Optional. Video frame-rate sampling density.
-                            "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                          },
-                        },
-                        "processingType": "A String",
-                        "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.
-          },
-          "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding).
-          },
-          "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.
-            "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool.
-              "queries": [ # Queries for Retrieval information.
-                "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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "sampleRate": 42, # The sample rate of the audio.
-                  "uri": "A String", # The URI of the audio.
-                },
-                "document": { # A document content block.
-                  "data": "A String", # The document content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "uri": "A String", # The URI of the document.
-                },
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                      { # The result of the File Search.
-                      },
-                    ],
-                  },
-                  "functionResult": { # A function tool result content block.
-                    "contentList": {
-                      "contents": [
-                        {
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                  "processingConfig": {
-                    "static": {
-                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                      "fps": 3.14, # Optional. Video frame-rate sampling density.
-                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                    },
-                  },
-                  "processingType": "A String",
-                  "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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "sampleRate": 42, # The sample rate of the audio.
-                  "uri": "A String", # The URI of the audio.
-                },
-                "document": { # A document content block.
-                  "data": "A String", # The document content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "uri": "A String", # The URI of the document.
-                },
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                      { # The result of the File Search.
-                      },
-                    ],
-                  },
-                  "functionResult": { # A function tool result content block.
-                    "contentList": {
-                      "contents": [
-                        {
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                  "processingConfig": {
-                    "static": {
-                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                      "fps": 3.14, # Optional. Video frame-rate sampling density.
-                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                    },
-                  },
-                  "processingType": "A String",
-                  "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.
-          },
-          "processingResult": { # The result of a server-initiated media processing step.
-          },
-          "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.
-            "isError": True or False, # Whether the retrieval resulted in an error.
-          },
-          "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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "sampleRate": 42, # The sample rate of the audio.
-                  "uri": "A String", # The URI of the audio.
-                },
-                "document": { # A document content block.
-                  "data": "A String", # The document content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "uri": "A String", # The URI of the document.
-                },
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                      { # The result of the File Search.
-                      },
-                    ],
-                  },
-                  "functionResult": { # A function tool result content block.
-                    "contentList": {
-                      "contents": [
-                        {
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                  "processingConfig": {
-                    "static": {
-                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                      "fps": 3.14, # Optional. Video frame-rate sampling density.
-                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                    },
-                  },
-                  "processingType": "A String",
-                  "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.
-        },
-      },
-    ],
-    "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.
-                "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "sampleRate": 42, # The sample rate of the audio.
-                "uri": "A String", # The URI of the audio.
-              },
-              "document": { # A document content block.
-                "data": "A String", # The document content.
-                "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "uri": "A String", # The URI of the document.
-              },
-              "image": { # An image content block.
-                "data": "A String", # The image content.
-                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "resolution": "A String", # The resolution of the media.
-                "uri": "A String", # The URI of the image.
-              },
-              "text": { # A text content block.
-                "annotations": [ # Citation information for model-generated content.
-                  { # Citation information for model-generated content.
-                    "endIndex": 42, # End of the attributed segment, exclusive.
-                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                      "documentUri": "A String", # The URI of the file.
-                      "fileName": "A String", # The name of the file.
-                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                      "source": "A String", # Source attributed for a portion of the text.
-                    },
-                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                      "name": "A String", # Title of the place.
-                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                          "reviewId": "A String", # The ID of the review snippet.
-                          "title": "A String", # Title of the review.
-                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                        },
-                      ],
-                      "url": "A String", # URI reference of the place.
-                    },
-                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                      "title": "A String", # The title of the URL.
-                      "url": "A String", # The URL.
-                    },
-                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                    { # The result of the File Search.
-                    },
-                  ],
-                },
-                "functionResult": { # A function tool result content block.
-                  "contentList": {
-                    "contents": [
-                      {
-                        "image": { # An image content block.
-                          "data": "A String", # The image content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                "processingConfig": {
-                  "static": {
-                    "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                    "fps": 3.14, # Optional. Video frame-rate sampling density.
-                    "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                  },
-                },
-                "processingType": "A String",
-                "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.
-          "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch.
-            "apiKey": "A String", # Required. The API key for ExaAiSearch.
-            "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API.
-              "a_key": "", # Properties of the object.
-            },
-          },
-          "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch.
-            "apiKey": "A String", # Optional. The API key for ParallelAiSearch.
-            "customConfig": { # Optional. Custom configs for ParallelAiSearch.
-              "a_key": "", # Properties of the object.
-            },
-          },
-          "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore.
-            "ragResources": [ # Optional. The representation of the rag source.
-              { # The definition of the Rag resource.
-                "ragCorpus": "A String", # Optional. RagCorpora resource name.
-                "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
-                  "A String",
-                ],
-              },
-            ],
-            "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
-              "filter": { # Config for filters. # Optional. Config for filters.
-                "metadataFilter": "A String", # Optional. String for metadata filtering.
-                "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
-                "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
-              },
-              "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
-                "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results.
-              },
-              "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
-                "rankService": { # Config for Rank Service. # Config for Rank Service.
-                  "modelName": "A String", # Optional. The model name of the rank service.
-                },
-              },
-              "topK": 42, # Optional. The number of contexts to retrieve.
-            },
-            "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
-            "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
-          },
-          "retrievalTypes": [ # The types of file retrieval to enable.
-            "A String",
-          ],
-          "vertexAiSearchConfig": { # 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.
-        },
-      },
-    ],
-    "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).
-    },
-  },
-  "store": True or False, # Input only. Whether to store the response and request for later retrieval.
-  "stream": True or False, # Input only. Whether the interaction will be streamed.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    {
-  "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.
-        "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",
-      },
-      "image": {
-        "data": "A String",
-        "mimeType": "A String",
-        "resolution": "A String", # The resolution of the media.
-        "uri": "A String",
-      },
-      "text": {
-        "text": "A String",
-      },
-      "textAnnotation": {
-        "annotations": [ # Citation information for model-generated content.
-          { # Citation information for model-generated content.
-            "endIndex": 42, # End of the attributed segment, exclusive.
-            "fileCitation": { # A file citation annotation. # A file citation annotation.
-              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-              "documentUri": "A String", # The URI of the file.
-              "fileName": "A String", # The name of the file.
-              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-              "pageNumber": 42, # Page number of the cited document, if applicable.
-              "source": "A String", # Source attributed for a portion of the text.
-            },
-            "placeCitation": { # A place citation annotation. # A place citation annotation.
-              "name": "A String", # Title of the place.
-              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                  "reviewId": "A String", # The ID of the review snippet.
-                  "title": "A String", # Title of the review.
-                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                },
-              ],
-              "url": "A String", # URI reference of the place.
-            },
-            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-              "title": "A String", # The title of the URL.
-              "url": "A String", # The URL.
-            },
-            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-              "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-              "text": "A String", # The transcribed word.
-            },
-          },
-        ],
-      },
-      "thoughtSignature": {
-        "signature": "A String", # Signature to match the backend source to be part of the generation.
-      },
-      "thoughtSummary": {
-        "content": { # The content of the response. # A new summary item to be added to the thought.
-          "audio": { # An audio content block.
-            "channels": 42, # The number of audio channels.
-            "data": "A String", # The audio content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "sampleRate": 42, # The sample rate of the audio.
-            "uri": "A String", # The URI of the audio.
-          },
-          "document": { # A document content block.
-            "data": "A String", # The document content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "uri": "A String", # The URI of the document.
-          },
-          "image": { # An image content block.
-            "data": "A String", # The image content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "resolution": "A String", # The resolution of the media.
-            "uri": "A String", # The URI of the image.
-          },
-          "text": { # A text content block.
-            "annotations": [ # Citation information for model-generated content.
-              { # Citation information for model-generated content.
-                "endIndex": 42, # End of the attributed segment, exclusive.
-                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                  "documentUri": "A String", # The URI of the file.
-                  "fileName": "A String", # The name of the file.
-                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                  "source": "A String", # Source attributed for a portion of the text.
-                },
-                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                  "name": "A String", # Title of the place.
-                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                      "reviewId": "A String", # The ID of the review snippet.
-                      "title": "A String", # Title of the review.
-                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                    },
-                  ],
-                  "url": "A String", # URI reference of the place.
-                },
-                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                  "title": "A String", # The title of the URL.
-                  "url": "A String", # The URL.
-                },
-                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                { # The result of the File Search.
-                },
-              ],
-            },
-            "functionResult": { # A function tool result content block.
-              "contentList": {
-                "contents": [
-                  {
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-            "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-            "processingConfig": {
-              "static": {
-                "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                "fps": 3.14, # Optional. Video frame-rate sampling density.
-                "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-              },
-            },
-            "processingType": "A String",
-            "resolution": "A String", # The resolution of the media.
-            "uri": "A String", # The URI of the video.
-          },
-        },
-      },
-      "toolCall": {
-        "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": {
-        },
-        "functionCall": {
-          "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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",
-        },
-        "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",
-            ],
-          },
-        },
-        "id": "A String", # Required. A unique ID for this specific tool call.
-        "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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",
-          "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",
-            ],
-          },
-        },
-      },
-      "toolResult": {
-        "callId": "A String", # Required. ID to match the ID from the function call block.
-        "codeExecutionResult": {
-          "isError": True or False,
-          "result": "A String",
-        },
-        "fileSearchResult": {
-          "result": [
-            { # The result of the File Search.
-            },
-          ],
-        },
-        "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.
-                "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "sampleRate": 42, # The sample rate of the audio.
-                "uri": "A String", # The URI of the audio.
-              },
-              "document": { # A document content block.
-                "data": "A String", # The document content.
-                "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "uri": "A String", # The URI of the document.
-              },
-              "image": { # An image content block.
-                "data": "A String", # The image content.
-                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "resolution": "A String", # The resolution of the media.
-                "uri": "A String", # The URI of the image.
-              },
-              "text": { # A text content block.
-                "annotations": [ # Citation information for model-generated content.
-                  { # Citation information for model-generated content.
-                    "endIndex": 42, # End of the attributed segment, exclusive.
-                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                      "documentUri": "A String", # The URI of the file.
-                      "fileName": "A String", # The name of the file.
-                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                      "source": "A String", # Source attributed for a portion of the text.
-                    },
-                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                      "name": "A String", # Title of the place.
-                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                          "reviewId": "A String", # The ID of the review snippet.
-                          "title": "A String", # Title of the review.
-                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                        },
-                      ],
-                      "url": "A String", # URI reference of the place.
-                    },
-                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                      "title": "A String", # The title of the URL.
-                      "url": "A String", # The URL.
-                    },
-                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                    { # The result of the File Search.
-                    },
-                  ],
-                },
-                "functionResult": { # A function tool result content block.
-                  "contentList": {
-                    "contents": [
-                      {
-                        "image": { # An image content block.
-                          "data": "A String", # The image content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                "processingConfig": {
-                  "static": {
-                    "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                    "fps": 3.14, # Optional. Video frame-rate sampling density.
-                    "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                  },
-                },
-                "processingType": "A String",
-                "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",
-          "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.
-                "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "sampleRate": 42, # The sample rate of the audio.
-                "uri": "A String", # The URI of the audio.
-              },
-              "document": { # A document content block.
-                "data": "A String", # The document content.
-                "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "uri": "A String", # The URI of the document.
-              },
-              "image": { # An image content block.
-                "data": "A String", # The image content.
-                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "resolution": "A String", # The resolution of the media.
-                "uri": "A String", # The URI of the image.
-              },
-              "text": { # A text content block.
-                "annotations": [ # Citation information for model-generated content.
-                  { # Citation information for model-generated content.
-                    "endIndex": 42, # End of the attributed segment, exclusive.
-                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                      "documentUri": "A String", # The URI of the file.
-                      "fileName": "A String", # The name of the file.
-                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                      "source": "A String", # Source attributed for a portion of the text.
-                    },
-                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                      "name": "A String", # Title of the place.
-                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                          "reviewId": "A String", # The ID of the review snippet.
-                          "title": "A String", # Title of the review.
-                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                        },
-                      ],
-                      "url": "A String", # URI reference of the place.
-                    },
-                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                      "title": "A String", # The title of the URL.
-                      "url": "A String", # The URL.
-                    },
-                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                    { # The result of the File Search.
-                    },
-                  ],
-                },
-                "functionResult": { # A function tool result content block.
-                  "contentList": {
-                    "contents": [
-                      {
-                        "image": { # An image content block.
-                          "data": "A String", # The image content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                "processingConfig": {
-                  "static": {
-                    "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                    "fps": 3.14, # Optional. Video frame-rate sampling density.
-                    "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                  },
-                },
-                "processingType": "A String",
-                "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",
-        },
-        "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.
-            },
-          ],
-        },
-      },
-      "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.
-        "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-        "sampleRate": 42, # The sample rate of the audio.
-        "uri": "A String", # The URI of the audio.
-      },
-      "document": { # A document content block.
-        "data": "A String", # The document content.
-        "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-        "uri": "A String", # The URI of the document.
-      },
-      "image": { # An image content block.
-        "data": "A String", # The image content.
-        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-        "resolution": "A String", # The resolution of the media.
-        "uri": "A String", # The URI of the image.
-      },
-      "text": { # A text content block.
-        "annotations": [ # Citation information for model-generated content.
-          { # Citation information for model-generated content.
-            "endIndex": 42, # End of the attributed segment, exclusive.
-            "fileCitation": { # A file citation annotation. # A file citation annotation.
-              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-              "documentUri": "A String", # The URI of the file.
-              "fileName": "A String", # The name of the file.
-              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-              "pageNumber": 42, # Page number of the cited document, if applicable.
-              "source": "A String", # Source attributed for a portion of the text.
-            },
-            "placeCitation": { # A place citation annotation. # A place citation annotation.
-              "name": "A String", # Title of the place.
-              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                  "reviewId": "A String", # The ID of the review snippet.
-                  "title": "A String", # Title of the review.
-                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                },
-              ],
-              "url": "A String", # URI reference of the place.
-            },
-            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-              "title": "A String", # The title of the URL.
-              "url": "A String", # The URL.
-            },
-            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-              "startOffset": "A String", # Start offset in time of the word relative to 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.
-              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-              "resolution": "A String", # The resolution of the media.
-              "uri": "A String", # The URI of the image.
-            },
-            "text": { # A text content block.
-              "annotations": [ # Citation information for model-generated content.
-                { # Citation information for model-generated content.
-                  "endIndex": 42, # End of the attributed segment, exclusive.
-                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                    "documentUri": "A String", # The URI of the file.
-                    "fileName": "A String", # The name of the file.
-                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                    "source": "A String", # Source attributed for a portion of the text.
-                  },
-                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                    "name": "A String", # Title of the place.
-                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                        "reviewId": "A String", # The ID of the review snippet.
-                        "title": "A String", # Title of the review.
-                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                      },
-                    ],
-                    "url": "A String", # URI reference of the place.
-                  },
-                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                    "title": "A String", # The title of the URL.
-                    "url": "A String", # The URL.
-                  },
-                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                    "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-            { # The result of the File Search.
-            },
-          ],
-        },
-        "functionResult": { # A function tool result content block.
-          "contentList": {
-            "contents": [
-              {
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-        "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-        "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-        "processingConfig": {
-          "static": {
-            "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-            "fps": 3.14, # Optional. Video frame-rate sampling density.
-            "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-          },
-        },
-        "processingType": "A String",
-        "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.
-          "findRequest": { # 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.
-            "findingId": "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.
-            "sourceFiles": [ # 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.
-              },
-            ],
-          },
-          "fixRequest": { # 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.
-            "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability.
-            "sourceFiles": [ # 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.
-          "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior.
-            "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout.
-          },
-          "sessionId": "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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.
-          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "sampleRate": 42, # The sample rate of the audio.
-          "uri": "A String", # The URI of the audio.
-        },
-        "document": { # A document content block.
-          "data": "A String", # The document content.
-          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "uri": "A String", # The URI of the document.
-        },
-        "image": { # An image content block.
-          "data": "A String", # The image content.
-          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "resolution": "A String", # The resolution of the media.
-          "uri": "A String", # The URI of the image.
-        },
-        "text": { # A text content block.
-          "annotations": [ # Citation information for model-generated content.
-            { # Citation information for model-generated content.
-              "endIndex": 42, # End of the attributed segment, exclusive.
-              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                "documentUri": "A String", # The URI of the file.
-                "fileName": "A String", # The name of the file.
-                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                "pageNumber": 42, # Page number of the cited document, if applicable.
-                "source": "A String", # Source attributed for a portion of the text.
-              },
-              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                "name": "A String", # Title of the place.
-                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                    "reviewId": "A String", # The ID of the review snippet.
-                    "title": "A String", # Title of the review.
-                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                  },
-                ],
-                "url": "A String", # URI reference of the place.
-              },
-              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                "title": "A String", # The title of the URL.
-                "url": "A String", # The URL.
-              },
-              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "resolution": "A String", # The resolution of the media.
-                "uri": "A String", # The URI of the image.
-              },
-              "text": { # A text content block.
-                "annotations": [ # Citation information for model-generated content.
-                  { # Citation information for model-generated content.
-                    "endIndex": 42, # End of the attributed segment, exclusive.
-                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                      "documentUri": "A String", # The URI of the file.
-                      "fileName": "A String", # The name of the file.
-                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                      "source": "A String", # Source attributed for a portion of the text.
-                    },
-                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                      "name": "A String", # Title of the place.
-                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                          "reviewId": "A String", # The ID of the review snippet.
-                          "title": "A String", # Title of the review.
-                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                        },
-                      ],
-                      "url": "A String", # URI reference of the place.
-                    },
-                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                      "title": "A String", # The title of the URL.
-                      "url": "A String", # The URL.
-                    },
-                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                      "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-              { # The result of the File Search.
-              },
-            ],
-          },
-          "functionResult": { # A function tool result content block.
-            "contentList": {
-              "contents": [
-                {
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-          "processingConfig": {
-            "static": {
-              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-              "fps": 3.14, # Optional. Video frame-rate sampling density.
-              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-            },
-          },
-          "processingType": "A String",
-          "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.
-              "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-              "sampleRate": 42, # The sample rate of the audio.
-              "uri": "A String", # The URI of the audio.
-            },
-            "document": { # A document content block.
-              "data": "A String", # The document content.
-              "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-              "uri": "A String", # The URI of the document.
-            },
-            "image": { # An image content block.
-              "data": "A String", # The image content.
-              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-              "resolution": "A String", # The resolution of the media.
-              "uri": "A String", # The URI of the image.
-            },
-            "text": { # A text content block.
-              "annotations": [ # Citation information for model-generated content.
-                { # Citation information for model-generated content.
-                  "endIndex": 42, # End of the attributed segment, exclusive.
-                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                    "documentUri": "A String", # The URI of the file.
-                    "fileName": "A String", # The name of the file.
-                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                    "source": "A String", # Source attributed for a portion of the text.
-                  },
-                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                    "name": "A String", # Title of the place.
-                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                        "reviewId": "A String", # The ID of the review snippet.
-                        "title": "A String", # Title of the review.
-                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                      },
-                    ],
-                    "url": "A String", # URI reference of the place.
-                  },
-                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                    "title": "A String", # The title of the URL.
-                    "url": "A String", # The URL.
-                  },
-                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                  { # The result of the File Search.
-                  },
-                ],
-              },
-              "functionResult": { # A function tool result content block.
-                "contentList": {
-                  "contents": [
-                    {
-                      "image": { # An image content block.
-                        "data": "A String", # The image content.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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.
-              "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-              "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-              "processingConfig": {
-                "static": {
-                  "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                  "fps": 3.14, # Optional. Video frame-rate sampling density.
-                  "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                },
-              },
-              "processingType": "A String",
-              "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.
-      "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction.
-        { # Error message from an interaction.
-          "code": "A String", # A URI that identifies the error type.
-          "message": "A String", # A human-readable error message.
-        },
-      ],
-      "id": "A String", # Required. Output only. A unique identifier for the interaction completion.
-      "labels": { # 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.
-          "stopSequences": [ # A list of character sequences that will stop output interaction.
-            "A String",
-          ],
-          "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration.
-            "speakers": [ # Individual speaker configurations.
-              { # 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.
-              },
-            ],
-          },
-          "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".
-            "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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.
-            "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "sampleRate": 42, # The sample rate of the audio.
-            "uri": "A String", # The URI of the audio.
-          },
-          "document": { # A document content block.
-            "data": "A String", # The document content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "uri": "A String", # The URI of the document.
-          },
-          "image": { # An image content block.
-            "data": "A String", # The image content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "resolution": "A String", # The resolution of the media.
-            "uri": "A String", # The URI of the image.
-          },
-          "text": { # A text content block.
-            "annotations": [ # Citation information for model-generated content.
-              { # Citation information for model-generated content.
-                "endIndex": 42, # End of the attributed segment, exclusive.
-                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                  "documentUri": "A String", # The URI of the file.
-                  "fileName": "A String", # The name of the file.
-                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                  "source": "A String", # Source attributed for a portion of the text.
-                },
-                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                  "name": "A String", # Title of the place.
-                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                      "reviewId": "A String", # The ID of the review snippet.
-                      "title": "A String", # Title of the review.
-                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                    },
-                  ],
-                  "url": "A String", # URI reference of the place.
-                },
-                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                  "title": "A String", # The title of the URL.
-                  "url": "A String", # The URL.
-                },
-                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                { # The result of the File Search.
-                },
-              ],
-            },
-            "functionResult": { # A function tool result content block.
-              "contentList": {
-                "contents": [
-                  {
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-            "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-            "processingConfig": {
-              "static": {
-                "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                "fps": 3.14, # Optional. Video frame-rate sampling density.
-                "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-              },
-            },
-            "processingType": "A String",
-            "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 Cloud Storage, this is the Cloud Storage 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.
-            "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "sampleRate": 42, # The sample rate of the audio.
-            "uri": "A String", # The URI of the audio.
-          },
-          "document": { # A document content block.
-            "data": "A String", # The document content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "uri": "A String", # The URI of the document.
-          },
-          "image": { # An image content block.
-            "data": "A String", # The image content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "resolution": "A String", # The resolution of the media.
-            "uri": "A String", # The URI of the image.
-          },
-          "text": { # A text content block.
-            "annotations": [ # Citation information for model-generated content.
-              { # Citation information for model-generated content.
-                "endIndex": 42, # End of the attributed segment, exclusive.
-                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                  "documentUri": "A String", # The URI of the file.
-                  "fileName": "A String", # The name of the file.
-                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                  "source": "A String", # Source attributed for a portion of the text.
-                },
-                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                  "name": "A String", # Title of the place.
-                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                      "reviewId": "A String", # The ID of the review snippet.
-                      "title": "A String", # Title of the review.
-                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                    },
-                  ],
-                  "url": "A String", # URI reference of the place.
-                },
-                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                  "title": "A String", # The title of the URL.
-                  "url": "A String", # The URL.
-                },
-                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                { # The result of the File Search.
-                },
-              ],
-            },
-            "functionResult": { # A function tool result content block.
-              "contentList": {
-                "contents": [
-                  {
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-            "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-            "processingConfig": {
-              "static": {
-                "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                "fps": 3.14, # Optional. Video frame-rate sampling density.
-                "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-              },
-            },
-            "processingType": "A String",
-            "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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "sampleRate": 42, # The sample rate of the audio.
-                        "uri": "A String", # The URI of the audio.
-                      },
-                      "document": { # A document content block.
-                        "data": "A String", # The document content.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "uri": "A String", # The URI of the document.
-                      },
-                      "image": { # An image content block.
-                        "data": "A String", # The image content.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                            { # The result of the File Search.
-                            },
-                          ],
-                        },
-                        "functionResult": { # A function tool result content block.
-                          "contentList": {
-                            "contents": [
-                              {
-                                "image": { # An image content block.
-                                  "data": "A String", # The image content.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                        "processingConfig": {
-                          "static": {
-                            "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                            "fps": 3.14, # Optional. Video frame-rate sampling density.
-                            "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                          },
-                        },
-                        "processingType": "A String",
-                        "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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "sampleRate": 42, # The sample rate of the audio.
-                          "uri": "A String", # The URI of the audio.
-                        },
-                        "document": { # A document content block.
-                          "data": "A String", # The document content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "uri": "A String", # The URI of the document.
-                        },
-                        "image": { # An image content block.
-                          "data": "A String", # The image content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                              { # The result of the File Search.
-                              },
-                            ],
-                          },
-                          "functionResult": { # A function tool result content block.
-                            "contentList": {
-                              "contents": [
-                                {
-                                  "image": { # An image content block.
-                                    "data": "A String", # The image content.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                          "processingConfig": {
-                            "static": {
-                              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                              "fps": 3.14, # Optional. Video frame-rate sampling density.
-                              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                            },
-                          },
-                          "processingType": "A String",
-                          "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI.
-              "resolution": "A String", # The video output resolution. Defaults to 720p.
-            },
-          },
-        ],
-      },
-      "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI.
-          "resolution": "A String", # The video output resolution. Defaults to 720p.
-        },
-      },
-      "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.
-      "safetySettings": [ # 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.
-        },
-      ],
-      "serviceTier": "A String", # The service tier for 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "sampleRate": 42, # The sample rate of the audio.
-                            "uri": "A String", # The URI of the audio.
-                          },
-                          "document": { # A document content block.
-                            "data": "A String", # The document content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "uri": "A String", # The URI of the document.
-                          },
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                                { # The result of the File Search.
-                                },
-                              ],
-                            },
-                            "functionResult": { # A function tool result content block.
-                              "contentList": {
-                                "contents": [
-                                  {
-                                    "image": { # An image content block.
-                                      "data": "A String", # The image content.
-                                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                      "resolution": "A String", # The resolution of the media.
-                                      "uri": "A String", # The URI of the image.
-                                    },
-                                    "text": { # A text content block.
-                                      "annotations": [ # Citation information for model-generated content.
-                                        { # Citation information for model-generated content.
-                                          "endIndex": 42, # End of the attributed segment, exclusive.
-                                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                            "documentUri": "A String", # The URI of the file.
-                                            "fileName": "A String", # The name of the file.
-                                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                                            "source": "A String", # Source attributed for a portion of the text.
-                                          },
-                                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                            "name": "A String", # Title of the place.
-                                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                                "reviewId": "A String", # The ID of the review snippet.
-                                                "title": "A String", # Title of the review.
-                                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                              },
-                                            ],
-                                            "url": "A String", # URI reference of the place.
-                                          },
-                                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                            "title": "A String", # The title of the URL.
-                                            "url": "A String", # The URL.
-                                          },
-                                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                      "resolution": "A String", # The resolution of the media.
-                                      "uri": "A String", # The URI of the image.
-                                    },
-                                    "text": { # A text content block.
-                                      "annotations": [ # Citation information for model-generated content.
-                                        { # Citation information for model-generated content.
-                                          "endIndex": 42, # End of the attributed segment, exclusive.
-                                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                            "documentUri": "A String", # The URI of the file.
-                                            "fileName": "A String", # The name of the file.
-                                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                                            "source": "A String", # Source attributed for a portion of the text.
-                                          },
-                                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                            "name": "A String", # Title of the place.
-                                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                                "reviewId": "A String", # The ID of the review snippet.
-                                                "title": "A String", # Title of the review.
-                                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                              },
-                                            ],
-                                            "url": "A String", # URI reference of the place.
-                                          },
-                                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                            "title": "A String", # The title of the URL.
-                                            "url": "A String", # The URL.
-                                          },
-                                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                            "processingConfig": {
-                              "static": {
-                                "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                                "fps": 3.14, # Optional. Video frame-rate sampling density.
-                                "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                              },
-                            },
-                            "processingType": "A String",
-                            "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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "sampleRate": 42, # The sample rate of the audio.
-                            "uri": "A String", # The URI of the audio.
-                          },
-                          "document": { # A document content block.
-                            "data": "A String", # The document content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "uri": "A String", # The URI of the document.
-                          },
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                                { # The result of the File Search.
-                                },
-                              ],
-                            },
-                            "functionResult": { # A function tool result content block.
-                              "contentList": {
-                                "contents": [
-                                  {
-                                    "image": { # An image content block.
-                                      "data": "A String", # The image content.
-                                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                      "resolution": "A String", # The resolution of the media.
-                                      "uri": "A String", # The URI of the image.
-                                    },
-                                    "text": { # A text content block.
-                                      "annotations": [ # Citation information for model-generated content.
-                                        { # Citation information for model-generated content.
-                                          "endIndex": 42, # End of the attributed segment, exclusive.
-                                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                            "documentUri": "A String", # The URI of the file.
-                                            "fileName": "A String", # The name of the file.
-                                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                                            "source": "A String", # Source attributed for a portion of the text.
-                                          },
-                                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                            "name": "A String", # Title of the place.
-                                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                                "reviewId": "A String", # The ID of the review snippet.
-                                                "title": "A String", # Title of the review.
-                                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                              },
-                                            ],
-                                            "url": "A String", # URI reference of the place.
-                                          },
-                                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                            "title": "A String", # The title of the URL.
-                                            "url": "A String", # The URL.
-                                          },
-                                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                      "resolution": "A String", # The resolution of the media.
-                                      "uri": "A String", # The URI of the image.
-                                    },
-                                    "text": { # A text content block.
-                                      "annotations": [ # Citation information for model-generated content.
-                                        { # Citation information for model-generated content.
-                                          "endIndex": 42, # End of the attributed segment, exclusive.
-                                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                            "documentUri": "A String", # The URI of the file.
-                                            "fileName": "A String", # The name of the file.
-                                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                                            "source": "A String", # Source attributed for a portion of the text.
-                                          },
-                                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                            "name": "A String", # Title of the place.
-                                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                                "reviewId": "A String", # The ID of the review snippet.
-                                                "title": "A String", # Title of the review.
-                                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                              },
-                                            ],
-                                            "url": "A String", # URI reference of the place.
-                                          },
-                                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                            "title": "A String", # The title of the URL.
-                                            "url": "A String", # The URL.
-                                          },
-                                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                            "processingConfig": {
-                              "static": {
-                                "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                                "fps": 3.14, # Optional. Video frame-rate sampling density.
-                                "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                              },
-                            },
-                            "processingType": "A String",
-                            "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.
-              },
-              "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding).
-              },
-              "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.
-                "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool.
-                  "queries": [ # Queries for Retrieval information.
-                    "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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.
-              },
-              "processingResult": { # The result of a server-initiated media processing step.
-              },
-              "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.
-                "isError": True or False, # Whether the retrieval resulted in an error.
-              },
-              "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "sampleRate": 42, # The sample rate of the audio.
-                  "uri": "A String", # The URI of the audio.
-                },
-                "document": { # A document content block.
-                  "data": "A String", # The document content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "uri": "A String", # The URI of the document.
-                },
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                      { # The result of the File Search.
-                      },
-                    ],
-                  },
-                  "functionResult": { # A function tool result content block.
-                    "contentList": {
-                      "contents": [
-                        {
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                  "processingConfig": {
-                    "static": {
-                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                      "fps": 3.14, # Optional. Video frame-rate sampling density.
-                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                    },
-                  },
-                  "processingType": "A String",
-                  "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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "sampleRate": 42, # The sample rate of the audio.
-                  "uri": "A String", # The URI of the audio.
-                },
-                "document": { # A document content block.
-                  "data": "A String", # The document content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "uri": "A String", # The URI of the document.
-                },
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                      { # The result of the File Search.
-                      },
-                    ],
-                  },
-                  "functionResult": { # A function tool result content block.
-                    "contentList": {
-                      "contents": [
-                        {
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                  "processingConfig": {
-                    "static": {
-                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                      "fps": 3.14, # Optional. Video frame-rate sampling density.
-                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                    },
-                  },
-                  "processingType": "A String",
-                  "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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "sampleRate": 42, # The sample rate of the audio.
-                          "uri": "A String", # The URI of the audio.
-                        },
-                        "document": { # A document content block.
-                          "data": "A String", # The document content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "uri": "A String", # The URI of the document.
-                        },
-                        "image": { # An image content block.
-                          "data": "A String", # The image content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                              { # The result of the File Search.
-                              },
-                            ],
-                          },
-                          "functionResult": { # A function tool result content block.
-                            "contentList": {
-                              "contents": [
-                                {
-                                  "image": { # An image content block.
-                                    "data": "A String", # The image content.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                          "processingConfig": {
-                            "static": {
-                              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                              "fps": 3.14, # Optional. Video frame-rate sampling density.
-                              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                            },
-                          },
-                          "processingType": "A String",
-                          "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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "sampleRate": 42, # The sample rate of the audio.
-                          "uri": "A String", # The URI of the audio.
-                        },
-                        "document": { # A document content block.
-                          "data": "A String", # The document content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "uri": "A String", # The URI of the document.
-                        },
-                        "image": { # An image content block.
-                          "data": "A String", # The image content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                              { # The result of the File Search.
-                              },
-                            ],
-                          },
-                          "functionResult": { # A function tool result content block.
-                            "contentList": {
-                              "contents": [
-                                {
-                                  "image": { # An image content block.
-                                    "data": "A String", # The image content.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                          "processingConfig": {
-                            "static": {
-                              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                              "fps": 3.14, # Optional. Video frame-rate sampling density.
-                              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                            },
-                          },
-                          "processingType": "A String",
-                          "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.
-            },
-            "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding).
-            },
-            "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.
-              "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool.
-                "queries": [ # Queries for Retrieval information.
-                  "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-            },
-            "processingResult": { # The result of a server-initiated media processing step.
-            },
-            "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.
-              "isError": True or False, # Whether the retrieval resulted in an error.
-            },
-            "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-          },
-        },
-      ],
-      "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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "sampleRate": 42, # The sample rate of the audio.
-                  "uri": "A String", # The URI of the audio.
-                },
-                "document": { # A document content block.
-                  "data": "A String", # The document content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "uri": "A String", # The URI of the document.
-                },
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                      { # The result of the File Search.
-                      },
-                    ],
-                  },
-                  "functionResult": { # A function tool result content block.
-                    "contentList": {
-                      "contents": [
-                        {
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                  "processingConfig": {
-                    "static": {
-                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                      "fps": 3.14, # Optional. Video frame-rate sampling density.
-                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                    },
-                  },
-                  "processingType": "A String",
-                  "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.
-            "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch.
-              "apiKey": "A String", # Required. The API key for ExaAiSearch.
-              "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API.
-                "a_key": "", # Properties of the object.
-              },
-            },
-            "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch.
-              "apiKey": "A String", # Optional. The API key for ParallelAiSearch.
-              "customConfig": { # Optional. Custom configs for ParallelAiSearch.
-                "a_key": "", # Properties of the object.
-              },
-            },
-            "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore.
-              "ragResources": [ # Optional. The representation of the rag source.
-                { # The definition of the Rag resource.
-                  "ragCorpus": "A String", # Optional. RagCorpora resource name.
-                  "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
-                    "A String",
-                  ],
-                },
-              ],
-              "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
-                "filter": { # Config for filters. # Optional. Config for filters.
-                  "metadataFilter": "A String", # Optional. String for metadata filtering.
-                  "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
-                  "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
-                },
-                "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
-                  "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results.
-                },
-                "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
-                  "rankService": { # Config for Rank Service. # Config for Rank Service.
-                    "modelName": "A String", # Optional. The model name of the rank service.
-                  },
-                },
-                "topK": 42, # Optional. The number of contexts to retrieve.
-              },
-              "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
-              "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
-            },
-            "retrievalTypes": [ # The types of file retrieval to enable.
-              "A String",
-            ],
-            "vertexAiSearchConfig": { # 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.
-          },
-        },
-      ],
-      "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.
-          "findRequest": { # 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.
-            "findingId": "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.
-            "sourceFiles": [ # 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.
-              },
-            ],
-          },
-          "fixRequest": { # 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.
-            "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability.
-            "sourceFiles": [ # 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.
-          "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior.
-            "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout.
-          },
-          "sessionId": "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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.
-          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "sampleRate": 42, # The sample rate of the audio.
-          "uri": "A String", # The URI of the audio.
-        },
-        "document": { # A document content block.
-          "data": "A String", # The document content.
-          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "uri": "A String", # The URI of the document.
-        },
-        "image": { # An image content block.
-          "data": "A String", # The image content.
-          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "resolution": "A String", # The resolution of the media.
-          "uri": "A String", # The URI of the image.
-        },
-        "text": { # A text content block.
-          "annotations": [ # Citation information for model-generated content.
-            { # Citation information for model-generated content.
-              "endIndex": 42, # End of the attributed segment, exclusive.
-              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                "documentUri": "A String", # The URI of the file.
-                "fileName": "A String", # The name of the file.
-                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                "pageNumber": 42, # Page number of the cited document, if applicable.
-                "source": "A String", # Source attributed for a portion of the text.
-              },
-              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                "name": "A String", # Title of the place.
-                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                    "reviewId": "A String", # The ID of the review snippet.
-                    "title": "A String", # Title of the review.
-                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                  },
-                ],
-                "url": "A String", # URI reference of the place.
-              },
-              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                "title": "A String", # The title of the URL.
-                "url": "A String", # The URL.
-              },
-              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "resolution": "A String", # The resolution of the media.
-                "uri": "A String", # The URI of the image.
-              },
-              "text": { # A text content block.
-                "annotations": [ # Citation information for model-generated content.
-                  { # Citation information for model-generated content.
-                    "endIndex": 42, # End of the attributed segment, exclusive.
-                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                      "documentUri": "A String", # The URI of the file.
-                      "fileName": "A String", # The name of the file.
-                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                      "source": "A String", # Source attributed for a portion of the text.
-                    },
-                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                      "name": "A String", # Title of the place.
-                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                          "reviewId": "A String", # The ID of the review snippet.
-                          "title": "A String", # Title of the review.
-                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                        },
-                      ],
-                      "url": "A String", # URI reference of the place.
-                    },
-                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                      "title": "A String", # The title of the URL.
-                      "url": "A String", # The URL.
-                    },
-                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                      "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-              { # The result of the File Search.
-              },
-            ],
-          },
-          "functionResult": { # A function tool result content block.
-            "contentList": {
-              "contents": [
-                {
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-          "processingConfig": {
-            "static": {
-              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-              "fps": 3.14, # Optional. Video frame-rate sampling density.
-              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-            },
-          },
-          "processingType": "A String",
-          "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.
-              "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-              "sampleRate": 42, # The sample rate of the audio.
-              "uri": "A String", # The URI of the audio.
-            },
-            "document": { # A document content block.
-              "data": "A String", # The document content.
-              "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-              "uri": "A String", # The URI of the document.
-            },
-            "image": { # An image content block.
-              "data": "A String", # The image content.
-              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-              "resolution": "A String", # The resolution of the media.
-              "uri": "A String", # The URI of the image.
-            },
-            "text": { # A text content block.
-              "annotations": [ # Citation information for model-generated content.
-                { # Citation information for model-generated content.
-                  "endIndex": 42, # End of the attributed segment, exclusive.
-                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                    "documentUri": "A String", # The URI of the file.
-                    "fileName": "A String", # The name of the file.
-                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                    "source": "A String", # Source attributed for a portion of the text.
-                  },
-                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                    "name": "A String", # Title of the place.
-                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                        "reviewId": "A String", # The ID of the review snippet.
-                        "title": "A String", # Title of the review.
-                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                      },
-                    ],
-                    "url": "A String", # URI reference of the place.
-                  },
-                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                    "title": "A String", # The title of the URL.
-                    "url": "A String", # The URL.
-                  },
-                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                  { # The result of the File Search.
-                  },
-                ],
-              },
-              "functionResult": { # A function tool result content block.
-                "contentList": {
-                  "contents": [
-                    {
-                      "image": { # An image content block.
-                        "data": "A String", # The image content.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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.
-              "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-              "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-              "processingConfig": {
-                "static": {
-                  "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                  "fps": 3.14, # Optional. Video frame-rate sampling density.
-                  "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                },
-              },
-              "processingType": "A String",
-              "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.
-      "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction.
-        { # Error message from an interaction.
-          "code": "A String", # A URI that identifies the error type.
-          "message": "A String", # A human-readable error message.
-        },
-      ],
-      "id": "A String", # Required. Output only. A unique identifier for the interaction completion.
-      "labels": { # 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.
-          "stopSequences": [ # A list of character sequences that will stop output interaction.
-            "A String",
-          ],
-          "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration.
-            "speakers": [ # Individual speaker configurations.
-              { # 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.
-              },
-            ],
-          },
-          "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".
-            "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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.
-            "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "sampleRate": 42, # The sample rate of the audio.
-            "uri": "A String", # The URI of the audio.
-          },
-          "document": { # A document content block.
-            "data": "A String", # The document content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "uri": "A String", # The URI of the document.
-          },
-          "image": { # An image content block.
-            "data": "A String", # The image content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "resolution": "A String", # The resolution of the media.
-            "uri": "A String", # The URI of the image.
-          },
-          "text": { # A text content block.
-            "annotations": [ # Citation information for model-generated content.
-              { # Citation information for model-generated content.
-                "endIndex": 42, # End of the attributed segment, exclusive.
-                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                  "documentUri": "A String", # The URI of the file.
-                  "fileName": "A String", # The name of the file.
-                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                  "source": "A String", # Source attributed for a portion of the text.
-                },
-                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                  "name": "A String", # Title of the place.
-                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                      "reviewId": "A String", # The ID of the review snippet.
-                      "title": "A String", # Title of the review.
-                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                    },
-                  ],
-                  "url": "A String", # URI reference of the place.
-                },
-                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                  "title": "A String", # The title of the URL.
-                  "url": "A String", # The URL.
-                },
-                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                { # The result of the File Search.
-                },
-              ],
-            },
-            "functionResult": { # A function tool result content block.
-              "contentList": {
-                "contents": [
-                  {
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-            "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-            "processingConfig": {
-              "static": {
-                "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                "fps": 3.14, # Optional. Video frame-rate sampling density.
-                "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-              },
-            },
-            "processingType": "A String",
-            "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 Cloud Storage, this is the Cloud Storage 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.
-            "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "sampleRate": 42, # The sample rate of the audio.
-            "uri": "A String", # The URI of the audio.
-          },
-          "document": { # A document content block.
-            "data": "A String", # The document content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "uri": "A String", # The URI of the document.
-          },
-          "image": { # An image content block.
-            "data": "A String", # The image content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "resolution": "A String", # The resolution of the media.
-            "uri": "A String", # The URI of the image.
-          },
-          "text": { # A text content block.
-            "annotations": [ # Citation information for model-generated content.
-              { # Citation information for model-generated content.
-                "endIndex": 42, # End of the attributed segment, exclusive.
-                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                  "documentUri": "A String", # The URI of the file.
-                  "fileName": "A String", # The name of the file.
-                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                  "source": "A String", # Source attributed for a portion of the text.
-                },
-                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                  "name": "A String", # Title of the place.
-                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                      "reviewId": "A String", # The ID of the review snippet.
-                      "title": "A String", # Title of the review.
-                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                    },
-                  ],
-                  "url": "A String", # URI reference of the place.
-                },
-                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                  "title": "A String", # The title of the URL.
-                  "url": "A String", # The URL.
-                },
-                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                { # The result of the File Search.
-                },
-              ],
-            },
-            "functionResult": { # A function tool result content block.
-              "contentList": {
-                "contents": [
-                  {
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-            "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-            "processingConfig": {
-              "static": {
-                "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                "fps": 3.14, # Optional. Video frame-rate sampling density.
-                "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-              },
-            },
-            "processingType": "A String",
-            "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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "sampleRate": 42, # The sample rate of the audio.
-                        "uri": "A String", # The URI of the audio.
-                      },
-                      "document": { # A document content block.
-                        "data": "A String", # The document content.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "uri": "A String", # The URI of the document.
-                      },
-                      "image": { # An image content block.
-                        "data": "A String", # The image content.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                            { # The result of the File Search.
-                            },
-                          ],
-                        },
-                        "functionResult": { # A function tool result content block.
-                          "contentList": {
-                            "contents": [
-                              {
-                                "image": { # An image content block.
-                                  "data": "A String", # The image content.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                        "processingConfig": {
-                          "static": {
-                            "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                            "fps": 3.14, # Optional. Video frame-rate sampling density.
-                            "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                          },
-                        },
-                        "processingType": "A String",
-                        "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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "sampleRate": 42, # The sample rate of the audio.
-                          "uri": "A String", # The URI of the audio.
-                        },
-                        "document": { # A document content block.
-                          "data": "A String", # The document content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "uri": "A String", # The URI of the document.
-                        },
-                        "image": { # An image content block.
-                          "data": "A String", # The image content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                              { # The result of the File Search.
-                              },
-                            ],
-                          },
-                          "functionResult": { # A function tool result content block.
-                            "contentList": {
-                              "contents": [
-                                {
-                                  "image": { # An image content block.
-                                    "data": "A String", # The image content.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                          "processingConfig": {
-                            "static": {
-                              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                              "fps": 3.14, # Optional. Video frame-rate sampling density.
-                              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                            },
-                          },
-                          "processingType": "A String",
-                          "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI.
-              "resolution": "A String", # The video output resolution. Defaults to 720p.
-            },
-          },
-        ],
-      },
-      "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI.
-          "resolution": "A String", # The video output resolution. Defaults to 720p.
-        },
-      },
-      "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.
-      "safetySettings": [ # 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.
-        },
-      ],
-      "serviceTier": "A String", # The service tier for 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "sampleRate": 42, # The sample rate of the audio.
-                            "uri": "A String", # The URI of the audio.
-                          },
-                          "document": { # A document content block.
-                            "data": "A String", # The document content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "uri": "A String", # The URI of the document.
-                          },
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                                { # The result of the File Search.
-                                },
-                              ],
-                            },
-                            "functionResult": { # A function tool result content block.
-                              "contentList": {
-                                "contents": [
-                                  {
-                                    "image": { # An image content block.
-                                      "data": "A String", # The image content.
-                                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                      "resolution": "A String", # The resolution of the media.
-                                      "uri": "A String", # The URI of the image.
-                                    },
-                                    "text": { # A text content block.
-                                      "annotations": [ # Citation information for model-generated content.
-                                        { # Citation information for model-generated content.
-                                          "endIndex": 42, # End of the attributed segment, exclusive.
-                                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                            "documentUri": "A String", # The URI of the file.
-                                            "fileName": "A String", # The name of the file.
-                                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                                            "source": "A String", # Source attributed for a portion of the text.
-                                          },
-                                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                            "name": "A String", # Title of the place.
-                                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                                "reviewId": "A String", # The ID of the review snippet.
-                                                "title": "A String", # Title of the review.
-                                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                              },
-                                            ],
-                                            "url": "A String", # URI reference of the place.
-                                          },
-                                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                            "title": "A String", # The title of the URL.
-                                            "url": "A String", # The URL.
-                                          },
-                                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                      "resolution": "A String", # The resolution of the media.
-                                      "uri": "A String", # The URI of the image.
-                                    },
-                                    "text": { # A text content block.
-                                      "annotations": [ # Citation information for model-generated content.
-                                        { # Citation information for model-generated content.
-                                          "endIndex": 42, # End of the attributed segment, exclusive.
-                                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                            "documentUri": "A String", # The URI of the file.
-                                            "fileName": "A String", # The name of the file.
-                                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                                            "source": "A String", # Source attributed for a portion of the text.
-                                          },
-                                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                            "name": "A String", # Title of the place.
-                                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                                "reviewId": "A String", # The ID of the review snippet.
-                                                "title": "A String", # Title of the review.
-                                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                              },
-                                            ],
-                                            "url": "A String", # URI reference of the place.
-                                          },
-                                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                            "title": "A String", # The title of the URL.
-                                            "url": "A String", # The URL.
-                                          },
-                                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                            "processingConfig": {
-                              "static": {
-                                "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                                "fps": 3.14, # Optional. Video frame-rate sampling density.
-                                "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                              },
-                            },
-                            "processingType": "A String",
-                            "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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "sampleRate": 42, # The sample rate of the audio.
-                            "uri": "A String", # The URI of the audio.
-                          },
-                          "document": { # A document content block.
-                            "data": "A String", # The document content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "uri": "A String", # The URI of the document.
-                          },
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                                { # The result of the File Search.
-                                },
-                              ],
-                            },
-                            "functionResult": { # A function tool result content block.
-                              "contentList": {
-                                "contents": [
-                                  {
-                                    "image": { # An image content block.
-                                      "data": "A String", # The image content.
-                                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                      "resolution": "A String", # The resolution of the media.
-                                      "uri": "A String", # The URI of the image.
-                                    },
-                                    "text": { # A text content block.
-                                      "annotations": [ # Citation information for model-generated content.
-                                        { # Citation information for model-generated content.
-                                          "endIndex": 42, # End of the attributed segment, exclusive.
-                                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                            "documentUri": "A String", # The URI of the file.
-                                            "fileName": "A String", # The name of the file.
-                                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                                            "source": "A String", # Source attributed for a portion of the text.
-                                          },
-                                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                            "name": "A String", # Title of the place.
-                                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                                "reviewId": "A String", # The ID of the review snippet.
-                                                "title": "A String", # Title of the review.
-                                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                              },
-                                            ],
-                                            "url": "A String", # URI reference of the place.
-                                          },
-                                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                            "title": "A String", # The title of the URL.
-                                            "url": "A String", # The URL.
-                                          },
-                                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                      "resolution": "A String", # The resolution of the media.
-                                      "uri": "A String", # The URI of the image.
-                                    },
-                                    "text": { # A text content block.
-                                      "annotations": [ # Citation information for model-generated content.
-                                        { # Citation information for model-generated content.
-                                          "endIndex": 42, # End of the attributed segment, exclusive.
-                                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                            "documentUri": "A String", # The URI of the file.
-                                            "fileName": "A String", # The name of the file.
-                                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                                            "source": "A String", # Source attributed for a portion of the text.
-                                          },
-                                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                            "name": "A String", # Title of the place.
-                                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                                "reviewId": "A String", # The ID of the review snippet.
-                                                "title": "A String", # Title of the review.
-                                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                              },
-                                            ],
-                                            "url": "A String", # URI reference of the place.
-                                          },
-                                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                            "title": "A String", # The title of the URL.
-                                            "url": "A String", # The URL.
-                                          },
-                                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                            "processingConfig": {
-                              "static": {
-                                "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                                "fps": 3.14, # Optional. Video frame-rate sampling density.
-                                "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                              },
-                            },
-                            "processingType": "A String",
-                            "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.
-              },
-              "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding).
-              },
-              "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.
-                "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool.
-                  "queries": [ # Queries for Retrieval information.
-                    "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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.
-              },
-              "processingResult": { # The result of a server-initiated media processing step.
-              },
-              "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.
-                "isError": True or False, # Whether the retrieval resulted in an error.
-              },
-              "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "sampleRate": 42, # The sample rate of the audio.
-                  "uri": "A String", # The URI of the audio.
-                },
-                "document": { # A document content block.
-                  "data": "A String", # The document content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "uri": "A String", # The URI of the document.
-                },
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                      { # The result of the File Search.
-                      },
-                    ],
-                  },
-                  "functionResult": { # A function tool result content block.
-                    "contentList": {
-                      "contents": [
-                        {
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                  "processingConfig": {
-                    "static": {
-                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                      "fps": 3.14, # Optional. Video frame-rate sampling density.
-                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                    },
-                  },
-                  "processingType": "A String",
-                  "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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "sampleRate": 42, # The sample rate of the audio.
-                  "uri": "A String", # The URI of the audio.
-                },
-                "document": { # A document content block.
-                  "data": "A String", # The document content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "uri": "A String", # The URI of the document.
-                },
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                      { # The result of the File Search.
-                      },
-                    ],
-                  },
-                  "functionResult": { # A function tool result content block.
-                    "contentList": {
-                      "contents": [
-                        {
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                  "processingConfig": {
-                    "static": {
-                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                      "fps": 3.14, # Optional. Video frame-rate sampling density.
-                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                    },
-                  },
-                  "processingType": "A String",
-                  "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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "sampleRate": 42, # The sample rate of the audio.
-                          "uri": "A String", # The URI of the audio.
-                        },
-                        "document": { # A document content block.
-                          "data": "A String", # The document content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "uri": "A String", # The URI of the document.
-                        },
-                        "image": { # An image content block.
-                          "data": "A String", # The image content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                              { # The result of the File Search.
-                              },
-                            ],
-                          },
-                          "functionResult": { # A function tool result content block.
-                            "contentList": {
-                              "contents": [
-                                {
-                                  "image": { # An image content block.
-                                    "data": "A String", # The image content.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                          "processingConfig": {
-                            "static": {
-                              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                              "fps": 3.14, # Optional. Video frame-rate sampling density.
-                              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                            },
-                          },
-                          "processingType": "A String",
-                          "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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "sampleRate": 42, # The sample rate of the audio.
-                          "uri": "A String", # The URI of the audio.
-                        },
-                        "document": { # A document content block.
-                          "data": "A String", # The document content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "uri": "A String", # The URI of the document.
-                        },
-                        "image": { # An image content block.
-                          "data": "A String", # The image content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                              { # The result of the File Search.
-                              },
-                            ],
-                          },
-                          "functionResult": { # A function tool result content block.
-                            "contentList": {
-                              "contents": [
-                                {
-                                  "image": { # An image content block.
-                                    "data": "A String", # The image content.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                          "processingConfig": {
-                            "static": {
-                              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                              "fps": 3.14, # Optional. Video frame-rate sampling density.
-                              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                            },
-                          },
-                          "processingType": "A String",
-                          "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.
-            },
-            "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding).
-            },
-            "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.
-              "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool.
-                "queries": [ # Queries for Retrieval information.
-                  "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-            },
-            "processingResult": { # The result of a server-initiated media processing step.
-            },
-            "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.
-              "isError": True or False, # Whether the retrieval resulted in an error.
-            },
-            "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-          },
-        },
-      ],
-      "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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "sampleRate": 42, # The sample rate of the audio.
-                  "uri": "A String", # The URI of the audio.
-                },
-                "document": { # A document content block.
-                  "data": "A String", # The document content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "uri": "A String", # The URI of the document.
-                },
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                      { # The result of the File Search.
-                      },
-                    ],
-                  },
-                  "functionResult": { # A function tool result content block.
-                    "contentList": {
-                      "contents": [
-                        {
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                  "processingConfig": {
-                    "static": {
-                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                      "fps": 3.14, # Optional. Video frame-rate sampling density.
-                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                    },
-                  },
-                  "processingType": "A String",
-                  "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.
-            "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch.
-              "apiKey": "A String", # Required. The API key for ExaAiSearch.
-              "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API.
-                "a_key": "", # Properties of the object.
-              },
-            },
-            "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch.
-              "apiKey": "A String", # Optional. The API key for ParallelAiSearch.
-              "customConfig": { # Optional. Custom configs for ParallelAiSearch.
-                "a_key": "", # Properties of the object.
-              },
-            },
-            "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore.
-              "ragResources": [ # Optional. The representation of the rag source.
-                { # The definition of the Rag resource.
-                  "ragCorpus": "A String", # Optional. RagCorpora resource name.
-                  "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
-                    "A String",
-                  ],
-                },
-              ],
-              "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
-                "filter": { # Config for filters. # Optional. Config for filters.
-                  "metadataFilter": "A String", # Optional. String for metadata filtering.
-                  "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
-                  "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
-                },
-                "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
-                  "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results.
-                },
-                "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
-                  "rankService": { # Config for Rank Service. # Config for Rank Service.
-                    "modelName": "A String", # Optional. The model name of the rank service.
-                  },
-                },
-                "topK": 42, # Optional. The number of contexts to retrieve.
-              },
-              "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
-              "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
-            },
-            "retrievalTypes": [ # The types of file retrieval to enable.
-              "A String",
-            ],
-            "vertexAiSearchConfig": { # 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.
-          },
-        },
-      ],
-      "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.
-        },
-        "codeMenderConfig": { # Configuration for the CodeMender agent.
-          "findRequest": { # 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.
-            "findingId": "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.
-            "sourceFiles": [ # 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.
-              },
-            ],
-          },
-          "fixRequest": { # 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.
-            "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability.
-            "sourceFiles": [ # 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.
-          "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior.
-            "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout.
-          },
-          "sessionId": "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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.
-          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "sampleRate": 42, # The sample rate of the audio.
-          "uri": "A String", # The URI of the audio.
-        },
-        "document": { # A document content block.
-          "data": "A String", # The document content.
-          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "uri": "A String", # The URI of the document.
-        },
-        "image": { # An image content block.
-          "data": "A String", # The image content.
-          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "resolution": "A String", # The resolution of the media.
-          "uri": "A String", # The URI of the image.
-        },
-        "text": { # A text content block.
-          "annotations": [ # Citation information for model-generated content.
-            { # Citation information for model-generated content.
-              "endIndex": 42, # End of the attributed segment, exclusive.
-              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                "documentUri": "A String", # The URI of the file.
-                "fileName": "A String", # The name of the file.
-                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                "pageNumber": 42, # Page number of the cited document, if applicable.
-                "source": "A String", # Source attributed for a portion of the text.
-              },
-              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                "name": "A String", # Title of the place.
-                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                    "reviewId": "A String", # The ID of the review snippet.
-                    "title": "A String", # Title of the review.
-                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                  },
-                ],
-                "url": "A String", # URI reference of the place.
-              },
-              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                "title": "A String", # The title of the URL.
-                "url": "A String", # The URL.
-              },
-              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                "resolution": "A String", # The resolution of the media.
-                "uri": "A String", # The URI of the image.
-              },
-              "text": { # A text content block.
-                "annotations": [ # Citation information for model-generated content.
-                  { # Citation information for model-generated content.
-                    "endIndex": 42, # End of the attributed segment, exclusive.
-                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                      "documentUri": "A String", # The URI of the file.
-                      "fileName": "A String", # The name of the file.
-                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                      "source": "A String", # Source attributed for a portion of the text.
-                    },
-                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                      "name": "A String", # Title of the place.
-                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                          "reviewId": "A String", # The ID of the review snippet.
-                          "title": "A String", # Title of the review.
-                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                        },
-                      ],
-                      "url": "A String", # URI reference of the place.
-                    },
-                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                      "title": "A String", # The title of the URL.
-                      "url": "A String", # The URL.
-                    },
-                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                      "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-              { # The result of the File Search.
-              },
-            ],
-          },
-          "functionResult": { # A function tool result content block.
-            "contentList": {
-              "contents": [
-                {
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-          "processingConfig": {
-            "static": {
-              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-              "fps": 3.14, # Optional. Video frame-rate sampling density.
-              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-            },
-          },
-          "processingType": "A String",
-          "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.
-              "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-              "sampleRate": 42, # The sample rate of the audio.
-              "uri": "A String", # The URI of the audio.
-            },
-            "document": { # A document content block.
-              "data": "A String", # The document content.
-              "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-              "uri": "A String", # The URI of the document.
-            },
-            "image": { # An image content block.
-              "data": "A String", # The image content.
-              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-              "resolution": "A String", # The resolution of the media.
-              "uri": "A String", # The URI of the image.
-            },
-            "text": { # A text content block.
-              "annotations": [ # Citation information for model-generated content.
-                { # Citation information for model-generated content.
-                  "endIndex": 42, # End of the attributed segment, exclusive.
-                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                    "documentUri": "A String", # The URI of the file.
-                    "fileName": "A String", # The name of the file.
-                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                    "source": "A String", # Source attributed for a portion of the text.
-                  },
-                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                    "name": "A String", # Title of the place.
-                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                        "reviewId": "A String", # The ID of the review snippet.
-                        "title": "A String", # Title of the review.
-                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                      },
-                    ],
-                    "url": "A String", # URI reference of the place.
-                  },
-                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                    "title": "A String", # The title of the URL.
-                    "url": "A String", # The URL.
-                  },
-                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                  { # The result of the File Search.
-                  },
-                ],
-              },
-              "functionResult": { # A function tool result content block.
-                "contentList": {
-                  "contents": [
-                    {
-                      "image": { # An image content block.
-                        "data": "A String", # The image content.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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.
-              "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-              "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-              "processingConfig": {
-                "static": {
-                  "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                  "fps": 3.14, # Optional. Video frame-rate sampling density.
-                  "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                },
-              },
-              "processingType": "A String",
-              "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.
-      "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction.
-        { # Error message from an interaction.
-          "code": "A String", # A URI that identifies the error type.
-          "message": "A String", # A human-readable error message.
-        },
-      ],
-      "id": "A String", # Required. Output only. A unique identifier for the interaction completion.
-      "labels": { # 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.
-          "stopSequences": [ # A list of character sequences that will stop output interaction.
-            "A String",
-          ],
-          "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration.
-            "speakers": [ # Individual speaker configurations.
-              { # 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.
-              },
-            ],
-          },
-          "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".
-            "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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.
-            "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "sampleRate": 42, # The sample rate of the audio.
-            "uri": "A String", # The URI of the audio.
-          },
-          "document": { # A document content block.
-            "data": "A String", # The document content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "uri": "A String", # The URI of the document.
-          },
-          "image": { # An image content block.
-            "data": "A String", # The image content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "resolution": "A String", # The resolution of the media.
-            "uri": "A String", # The URI of the image.
-          },
-          "text": { # A text content block.
-            "annotations": [ # Citation information for model-generated content.
-              { # Citation information for model-generated content.
-                "endIndex": 42, # End of the attributed segment, exclusive.
-                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                  "documentUri": "A String", # The URI of the file.
-                  "fileName": "A String", # The name of the file.
-                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                  "source": "A String", # Source attributed for a portion of the text.
-                },
-                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                  "name": "A String", # Title of the place.
-                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                      "reviewId": "A String", # The ID of the review snippet.
-                      "title": "A String", # Title of the review.
-                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                    },
-                  ],
-                  "url": "A String", # URI reference of the place.
-                },
-                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                  "title": "A String", # The title of the URL.
-                  "url": "A String", # The URL.
-                },
-                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                { # The result of the File Search.
-                },
-              ],
-            },
-            "functionResult": { # A function tool result content block.
-              "contentList": {
-                "contents": [
-                  {
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-            "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-            "processingConfig": {
-              "static": {
-                "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                "fps": 3.14, # Optional. Video frame-rate sampling density.
-                "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-              },
-            },
-            "processingType": "A String",
-            "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 Cloud Storage, this is the Cloud Storage 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.
-            "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "sampleRate": 42, # The sample rate of the audio.
-            "uri": "A String", # The URI of the audio.
-          },
-          "document": { # A document content block.
-            "data": "A String", # The document content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "uri": "A String", # The URI of the document.
-          },
-          "image": { # An image content block.
-            "data": "A String", # The image content.
-            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "resolution": "A String", # The resolution of the media.
-            "uri": "A String", # The URI of the image.
-          },
-          "text": { # A text content block.
-            "annotations": [ # Citation information for model-generated content.
-              { # Citation information for model-generated content.
-                "endIndex": 42, # End of the attributed segment, exclusive.
-                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                  "documentUri": "A String", # The URI of the file.
-                  "fileName": "A String", # The name of the file.
-                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                  "source": "A String", # Source attributed for a portion of the text.
-                },
-                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                  "name": "A String", # Title of the place.
-                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                      "reviewId": "A String", # The ID of the review snippet.
-                      "title": "A String", # Title of the review.
-                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                    },
-                  ],
-                  "url": "A String", # URI reference of the place.
-                },
-                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                  "title": "A String", # The title of the URL.
-                  "url": "A String", # The URL.
-                },
-                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                { # The result of the File Search.
-                },
-              ],
-            },
-            "functionResult": { # A function tool result content block.
-              "contentList": {
-                "contents": [
-                  {
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-            "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-            "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-            "processingConfig": {
-              "static": {
-                "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                "fps": 3.14, # Optional. Video frame-rate sampling density.
-                "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-              },
-            },
-            "processingType": "A String",
-            "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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "sampleRate": 42, # The sample rate of the audio.
-                        "uri": "A String", # The URI of the audio.
-                      },
-                      "document": { # A document content block.
-                        "data": "A String", # The document content.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "uri": "A String", # The URI of the document.
-                      },
-                      "image": { # An image content block.
-                        "data": "A String", # The image content.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                            { # The result of the File Search.
-                            },
-                          ],
-                        },
-                        "functionResult": { # A function tool result content block.
-                          "contentList": {
-                            "contents": [
-                              {
-                                "image": { # An image content block.
-                                  "data": "A String", # The image content.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                        "processingConfig": {
-                          "static": {
-                            "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                            "fps": 3.14, # Optional. Video frame-rate sampling density.
-                            "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                          },
-                        },
-                        "processingType": "A String",
-                        "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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "sampleRate": 42, # The sample rate of the audio.
-                          "uri": "A String", # The URI of the audio.
-                        },
-                        "document": { # A document content block.
-                          "data": "A String", # The document content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "uri": "A String", # The URI of the document.
-                        },
-                        "image": { # An image content block.
-                          "data": "A String", # The image content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                              { # The result of the File Search.
-                              },
-                            ],
-                          },
-                          "functionResult": { # A function tool result content block.
-                            "contentList": {
-                              "contents": [
-                                {
-                                  "image": { # An image content block.
-                                    "data": "A String", # The image content.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                          "processingConfig": {
-                            "static": {
-                              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                              "fps": 3.14, # Optional. Video frame-rate sampling density.
-                              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                            },
-                          },
-                          "processingType": "A String",
-                          "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI.
-              "resolution": "A String", # The video output resolution. Defaults to 720p.
-            },
-          },
-        ],
-      },
-      "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI.
-          "resolution": "A String", # The video output resolution. Defaults to 720p.
-        },
-      },
-      "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.
-      "safetySettings": [ # 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.
-        },
-      ],
-      "serviceTier": "A String", # The service tier for 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "sampleRate": 42, # The sample rate of the audio.
-                    "uri": "A String", # The URI of the audio.
-                  },
-                  "document": { # A document content block.
-                    "data": "A String", # The document content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "uri": "A String", # The URI of the document.
-                  },
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                            },
-                          ],
-                          "url": "A String", # URI reference of the place.
-                        },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
-                        },
-                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                        { # The result of the File Search.
-                        },
-                      ],
-                    },
-                    "functionResult": { # A function tool result content block.
-                      "contentList": {
-                        "contents": [
-                          {
-                            "image": { # An image content block.
-                              "data": "A String", # The image content.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                              "resolution": "A String", # The resolution of the media.
-                              "uri": "A String", # The URI of the image.
-                            },
-                            "text": { # A text content block.
-                              "annotations": [ # Citation information for model-generated content.
-                                { # Citation information for model-generated content.
-                                  "endIndex": 42, # End of the attributed segment, exclusive.
-                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                    "documentUri": "A String", # The URI of the file.
-                                    "fileName": "A String", # The name of the file.
-                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                                    "source": "A String", # Source attributed for a portion of the text.
-                                  },
-                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                    "name": "A String", # Title of the place.
-                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                        "reviewId": "A String", # The ID of the review snippet.
-                                        "title": "A String", # Title of the review.
-                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                      },
-                                    ],
-                                    "url": "A String", # URI reference of the place.
-                                  },
-                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                    "title": "A String", # The title of the URL.
-                                    "url": "A String", # The URL.
-                                  },
-                                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                    "startOffset": "A String", # Start offset in time of the word relative to 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.
-                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                    "processingConfig": {
-                      "static": {
-                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                        "fps": 3.14, # Optional. Video frame-rate sampling density.
-                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                      },
-                    },
-                    "processingType": "A String",
-                    "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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "sampleRate": 42, # The sample rate of the audio.
-                            "uri": "A String", # The URI of the audio.
-                          },
-                          "document": { # A document content block.
-                            "data": "A String", # The document content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "uri": "A String", # The URI of the document.
-                          },
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                                { # The result of the File Search.
-                                },
-                              ],
-                            },
-                            "functionResult": { # A function tool result content block.
-                              "contentList": {
-                                "contents": [
-                                  {
-                                    "image": { # An image content block.
-                                      "data": "A String", # The image content.
-                                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                      "resolution": "A String", # The resolution of the media.
-                                      "uri": "A String", # The URI of the image.
-                                    },
-                                    "text": { # A text content block.
-                                      "annotations": [ # Citation information for model-generated content.
-                                        { # Citation information for model-generated content.
-                                          "endIndex": 42, # End of the attributed segment, exclusive.
-                                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                            "documentUri": "A String", # The URI of the file.
-                                            "fileName": "A String", # The name of the file.
-                                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                                            "source": "A String", # Source attributed for a portion of the text.
-                                          },
-                                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                            "name": "A String", # Title of the place.
-                                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                                "reviewId": "A String", # The ID of the review snippet.
-                                                "title": "A String", # Title of the review.
-                                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                              },
-                                            ],
-                                            "url": "A String", # URI reference of the place.
-                                          },
-                                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                            "title": "A String", # The title of the URL.
-                                            "url": "A String", # The URL.
-                                          },
-                                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                      "resolution": "A String", # The resolution of the media.
-                                      "uri": "A String", # The URI of the image.
-                                    },
-                                    "text": { # A text content block.
-                                      "annotations": [ # Citation information for model-generated content.
-                                        { # Citation information for model-generated content.
-                                          "endIndex": 42, # End of the attributed segment, exclusive.
-                                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                            "documentUri": "A String", # The URI of the file.
-                                            "fileName": "A String", # The name of the file.
-                                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                                            "source": "A String", # Source attributed for a portion of the text.
-                                          },
-                                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                            "name": "A String", # Title of the place.
-                                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                                "reviewId": "A String", # The ID of the review snippet.
-                                                "title": "A String", # Title of the review.
-                                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                              },
-                                            ],
-                                            "url": "A String", # URI reference of the place.
-                                          },
-                                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                            "title": "A String", # The title of the URL.
-                                            "url": "A String", # The URL.
-                                          },
-                                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                            "processingConfig": {
-                              "static": {
-                                "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                                "fps": 3.14, # Optional. Video frame-rate sampling density.
-                                "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                              },
-                            },
-                            "processingType": "A String",
-                            "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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "sampleRate": 42, # The sample rate of the audio.
-                            "uri": "A String", # The URI of the audio.
-                          },
-                          "document": { # A document content block.
-                            "data": "A String", # The document content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "uri": "A String", # The URI of the document.
-                          },
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                  "resolution": "A String", # The resolution of the media.
-                                  "uri": "A String", # The URI of the image.
-                                },
-                                "text": { # A text content block.
-                                  "annotations": [ # Citation information for model-generated content.
-                                    { # Citation information for model-generated content.
-                                      "endIndex": 42, # End of the attributed segment, exclusive.
-                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                        "documentUri": "A String", # The URI of the file.
-                                        "fileName": "A String", # The name of the file.
-                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                                        "source": "A String", # Source attributed for a portion of the text.
-                                      },
-                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                        "name": "A String", # Title of the place.
-                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                            "reviewId": "A String", # The ID of the review snippet.
-                                            "title": "A String", # Title of the review.
-                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                          },
-                                        ],
-                                        "url": "A String", # URI reference of the place.
-                                      },
-                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                        "title": "A String", # The title of the URL.
-                                        "url": "A String", # The URL.
-                                      },
-                                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                        "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                                { # The result of the File Search.
-                                },
-                              ],
-                            },
-                            "functionResult": { # A function tool result content block.
-                              "contentList": {
-                                "contents": [
-                                  {
-                                    "image": { # An image content block.
-                                      "data": "A String", # The image content.
-                                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                      "resolution": "A String", # The resolution of the media.
-                                      "uri": "A String", # The URI of the image.
-                                    },
-                                    "text": { # A text content block.
-                                      "annotations": [ # Citation information for model-generated content.
-                                        { # Citation information for model-generated content.
-                                          "endIndex": 42, # End of the attributed segment, exclusive.
-                                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                            "documentUri": "A String", # The URI of the file.
-                                            "fileName": "A String", # The name of the file.
-                                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                                            "source": "A String", # Source attributed for a portion of the text.
-                                          },
-                                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                            "name": "A String", # Title of the place.
-                                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                                "reviewId": "A String", # The ID of the review snippet.
-                                                "title": "A String", # Title of the review.
-                                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                              },
-                                            ],
-                                            "url": "A String", # URI reference of the place.
-                                          },
-                                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                            "title": "A String", # The title of the URL.
-                                            "url": "A String", # The URL.
-                                          },
-                                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                      "resolution": "A String", # The resolution of the media.
-                                      "uri": "A String", # The URI of the image.
-                                    },
-                                    "text": { # A text content block.
-                                      "annotations": [ # Citation information for model-generated content.
-                                        { # Citation information for model-generated content.
-                                          "endIndex": 42, # End of the attributed segment, exclusive.
-                                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                            "documentUri": "A String", # The URI of the file.
-                                            "fileName": "A String", # The name of the file.
-                                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                                            "source": "A String", # Source attributed for a portion of the text.
-                                          },
-                                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                            "name": "A String", # Title of the place.
-                                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                                "reviewId": "A String", # The ID of the review snippet.
-                                                "title": "A String", # Title of the review.
-                                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                              },
-                                            ],
-                                            "url": "A String", # URI reference of the place.
-                                          },
-                                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                            "title": "A String", # The title of the URL.
-                                            "url": "A String", # The URL.
-                                          },
-                                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                            "processingConfig": {
-                              "static": {
-                                "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                                "fps": 3.14, # Optional. Video frame-rate sampling density.
-                                "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                              },
-                            },
-                            "processingType": "A String",
-                            "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.
-              },
-              "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding).
-              },
-              "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.
-                "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool.
-                  "queries": [ # Queries for Retrieval information.
-                    "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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.
-              },
-              "processingResult": { # The result of a server-initiated media processing step.
-              },
-              "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.
-                "isError": True or False, # Whether the retrieval resulted in an error.
-              },
-              "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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "sampleRate": 42, # The sample rate of the audio.
-                      "uri": "A String", # The URI of the audio.
-                    },
-                    "document": { # A document content block.
-                      "data": "A String", # The document content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "uri": "A String", # The URI of the document.
-                    },
-                    "image": { # An image content block.
-                      "data": "A String", # The image content.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "resolution": "A String", # The resolution of the media.
-                      "uri": "A String", # The URI of the image.
-                    },
-                    "text": { # A text content block.
-                      "annotations": [ # Citation information for model-generated content.
-                        { # Citation information for model-generated content.
-                          "endIndex": 42, # End of the attributed segment, exclusive.
-                          "fileCitation": { # A file citation annotation. # A file citation annotation.
-                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                            "documentUri": "A String", # The URI of the file.
-                            "fileName": "A String", # The name of the file.
-                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                            "pageNumber": 42, # Page number of the cited document, if applicable.
-                            "source": "A String", # Source attributed for a portion of the text.
-                          },
-                          "placeCitation": { # A place citation annotation. # A place citation annotation.
-                            "name": "A String", # Title of the place.
-                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                "reviewId": "A String", # The ID of the review snippet.
-                                "title": "A String", # Title of the review.
-                                "url": "A String", # A link that corresponds to the user review on Google Maps.
-                              },
-                            ],
-                            "url": "A String", # URI reference of the place.
-                          },
-                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                            "title": "A String", # The title of the URL.
-                            "url": "A String", # The URL.
-                          },
-                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                            "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                          { # The result of the File Search.
-                          },
-                        ],
-                      },
-                      "functionResult": { # A function tool result content block.
-                        "contentList": {
-                          "contents": [
-                            {
-                              "image": { # An image content block.
-                                "data": "A String", # The image content.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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.
-                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                      "processingConfig": {
-                        "static": {
-                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                          "fps": 3.14, # Optional. Video frame-rate sampling density.
-                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                        },
-                      },
-                      "processingType": "A String",
-                      "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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "sampleRate": 42, # The sample rate of the audio.
-                  "uri": "A String", # The URI of the audio.
-                },
-                "document": { # A document content block.
-                  "data": "A String", # The document content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "uri": "A String", # The URI of the document.
-                },
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                      { # The result of the File Search.
-                      },
-                    ],
-                  },
-                  "functionResult": { # A function tool result content block.
-                    "contentList": {
-                      "contents": [
-                        {
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                  "processingConfig": {
-                    "static": {
-                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                      "fps": 3.14, # Optional. Video frame-rate sampling density.
-                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                    },
-                  },
-                  "processingType": "A String",
-                  "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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "sampleRate": 42, # The sample rate of the audio.
-                  "uri": "A String", # The URI of the audio.
-                },
-                "document": { # A document content block.
-                  "data": "A String", # The document content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "uri": "A String", # The URI of the document.
-                },
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
-                          },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                        "startOffset": "A String", # Start offset in time of the word relative to 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.
-                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                        "resolution": "A String", # The resolution of the media.
-                        "uri": "A String", # The URI of the image.
-                      },
-                      "text": { # A text content block.
-                        "annotations": [ # Citation information for model-generated content.
-                          { # Citation information for model-generated content.
-                            "endIndex": 42, # End of the attributed segment, exclusive.
-                            "fileCitation": { # A file citation annotation. # A file citation annotation.
-                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                              "documentUri": "A String", # The URI of the file.
-                              "fileName": "A String", # The name of the file.
-                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                              "pageNumber": 42, # Page number of the cited document, if applicable.
-                              "source": "A String", # Source attributed for a portion of the text.
-                            },
-                            "placeCitation": { # A place citation annotation. # A place citation annotation.
-                              "name": "A String", # Title of the place.
-                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                  "reviewId": "A String", # The ID of the review snippet.
-                                  "title": "A String", # Title of the review.
-                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                },
-                              ],
-                              "url": "A String", # URI reference of the place.
-                            },
-                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                              "title": "A String", # The title of the URL.
-                              "url": "A String", # The URL.
-                            },
-                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                              "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                      { # The result of the File Search.
-                      },
-                    ],
-                  },
-                  "functionResult": { # A function tool result content block.
-                    "contentList": {
-                      "contents": [
-                        {
-                          "image": { # An image content block.
-                            "data": "A String", # The image content.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                            "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                            "resolution": "A String", # The resolution of the media.
-                            "uri": "A String", # The URI of the image.
-                          },
-                          "text": { # A text content block.
-                            "annotations": [ # Citation information for model-generated content.
-                              { # Citation information for model-generated content.
-                                "endIndex": 42, # End of the attributed segment, exclusive.
-                                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                  "documentUri": "A String", # The URI of the file.
-                                  "fileName": "A String", # The name of the file.
-                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                                  "source": "A String", # Source attributed for a portion of the text.
-                                },
-                                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                  "name": "A String", # Title of the place.
-                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                      "reviewId": "A String", # The ID of the review snippet.
-                                      "title": "A String", # Title of the review.
-                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                    },
-                                  ],
-                                  "url": "A String", # URI reference of the place.
-                                },
-                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                  "title": "A String", # The title of the URL.
-                                  "url": "A String", # The URL.
-                                },
-                                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                  "startOffset": "A String", # Start offset in time of the word relative to 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.
-                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                  "processingConfig": {
-                    "static": {
-                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                      "fps": 3.14, # Optional. Video frame-rate sampling density.
-                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                    },
-                  },
-                  "processingType": "A String",
-                  "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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "sampleRate": 42, # The sample rate of the audio.
-                          "uri": "A String", # The URI of the audio.
-                        },
-                        "document": { # A document content block.
-                          "data": "A String", # The document content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "uri": "A String", # The URI of the document.
-                        },
-                        "image": { # An image content block.
-                          "data": "A String", # The image content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                              { # The result of the File Search.
-                              },
-                            ],
-                          },
-                          "functionResult": { # A function tool result content block.
-                            "contentList": {
-                              "contents": [
-                                {
-                                  "image": { # An image content block.
-                                    "data": "A String", # The image content.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                          "processingConfig": {
-                            "static": {
-                              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                              "fps": 3.14, # Optional. Video frame-rate sampling density.
-                              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                            },
-                          },
-                          "processingType": "A String",
-                          "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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "sampleRate": 42, # The sample rate of the audio.
-                          "uri": "A String", # The URI of the audio.
-                        },
-                        "document": { # A document content block.
-                          "data": "A String", # The document content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "uri": "A String", # The URI of the document.
-                        },
-                        "image": { # An image content block.
-                          "data": "A String", # The image content.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the image.
-                        },
-                        "text": { # A text content block.
-                          "annotations": [ # Citation information for model-generated content.
-                            { # Citation information for model-generated content.
-                              "endIndex": 42, # End of the attributed segment, exclusive.
-                              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                "documentUri": "A String", # The URI of the file.
-                                "fileName": "A String", # The name of the file.
-                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                "pageNumber": 42, # Page number of the cited document, if applicable.
-                                "source": "A String", # Source attributed for a portion of the text.
-                              },
-                              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                "name": "A String", # Title of the place.
-                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                    "reviewId": "A String", # The ID of the review snippet.
-                                    "title": "A String", # Title of the review.
-                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                  },
-                                ],
-                                "url": "A String", # URI reference of the place.
-                              },
-                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                "title": "A String", # The title of the URL.
-                                "url": "A String", # The URL.
-                              },
-                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                "resolution": "A String", # The resolution of the media.
-                                "uri": "A String", # The URI of the image.
-                              },
-                              "text": { # A text content block.
-                                "annotations": [ # Citation information for model-generated content.
-                                  { # Citation information for model-generated content.
-                                    "endIndex": 42, # End of the attributed segment, exclusive.
-                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                      "documentUri": "A String", # The URI of the file.
-                                      "fileName": "A String", # The name of the file.
-                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                                      "source": "A String", # Source attributed for a portion of the text.
-                                    },
-                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                      "name": "A String", # Title of the place.
-                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                          "reviewId": "A String", # The ID of the review snippet.
-                                          "title": "A String", # Title of the review.
-                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                        },
-                                      ],
-                                      "url": "A String", # URI reference of the place.
-                                    },
-                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                      "title": "A String", # The title of the URL.
-                                      "url": "A String", # The URL.
-                                    },
-                                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                      "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search.
-                              { # The result of the File Search.
-                              },
-                            ],
-                          },
-                          "functionResult": { # A function tool result content block.
-                            "contentList": {
-                              "contents": [
-                                {
-                                  "image": { # An image content block.
-                                    "data": "A String", # The image content.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                                    "resolution": "A String", # The resolution of the media.
-                                    "uri": "A String", # The URI of the image.
-                                  },
-                                  "text": { # A text content block.
-                                    "annotations": [ # Citation information for model-generated content.
-                                      { # Citation information for model-generated content.
-                                        "endIndex": 42, # End of the attributed segment, exclusive.
-                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                                          "documentUri": "A String", # The URI of the file.
-                                          "fileName": "A String", # The name of the file.
-                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                                          "source": "A String", # Source attributed for a portion of the text.
-                                        },
-                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                                          "name": "A String", # Title of the place.
-                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                                              "reviewId": "A String", # The ID of the review snippet.
-                                              "title": "A String", # Title of the review.
-                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
-                                            },
-                                          ],
-                                          "url": "A String", # URI reference of the place.
-                                        },
-                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                                          "title": "A String", # The title of the URL.
-                                          "url": "A String", # The URL.
-                                        },
-                                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                                          "startOffset": "A String", # Start offset in time of the word relative to 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.
-                          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-                          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
-                          "processingConfig": {
-                            "static": {
-                              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
-                              "fps": 3.14, # Optional. Video frame-rate sampling density.
-                              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
-                            },
-                          },
-                          "processingType": "A String",
-                          "resolution": "A String", # The resolution of the media.
-                          "uri": "A String", # The URI of the video.
-                        },
+          "retrievalTypes": [ # The types of file retrieval to enable.
+            "A String",
+          ],
+          "vertexAiSearchConfig": { # 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.
+        },
+      },
+    ],
+    "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).
+    },
+  },
+  "store": True or False, # Input only. Whether to store the response and request for later retrieval.
+  "stream": True or False, # Input only. Whether the interaction will be streamed.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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.
+      "findRequest": { # 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.
+        "findingId": "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.
+        "sourceFiles": [ # 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.
+          },
+        ],
+      },
+      "fixRequest": { # 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.
+        "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability.
+        "sourceFiles": [ # 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.
+      "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior.
+        "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout.
+      },
+      "sessionId": "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.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
                       },
-                      "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                        "values": [ # Repeated field of dynamically typed values.
-                          # Object with schema name: GenaiVertexV1beta1Value
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
                         ],
+                        "url": "A String", # URI reference of the place.
                       },
-                      "nullValue": "A String", # Represents a null value.
-                      "numberValue": 3.14, # Represents a double value.
-                      "stringValue": "A String", # Represents a string value.
-                      "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                        "startOffset": "A String", # Start offset in time of the word relative to 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.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                  "processingConfig": {
+                    "static": {
+                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                      "fps": 3.14, # Optional. Video frame-rate sampling density.
+                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
                     },
                   },
-                ],
+                  "processingType": "A String",
+                  "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.
-            },
-            "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding).
-            },
-            "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.
-              "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool.
-                "queries": [ # Queries for Retrieval information.
-                  "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
                 ],
               },
-              "retrievalType": "A String", # The type of retrieval tools.
+              "nullValue": "A String", # Represents a null value.
+              "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.
-            "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.
+      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+      "sampleRate": 42, # The sample rate of the audio.
+      "uri": "A String", # The URI of the audio.
+    },
+    "document": { # A document content block.
+      "data": "A String", # The document content.
+      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+      "uri": "A String", # The URI of the document.
+    },
+    "image": { # An image content block.
+      "data": "A String", # The image content.
+      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+      "resolution": "A String", # The resolution of the media.
+      "uri": "A String", # The URI of the image.
+    },
+    "text": { # A text content block.
+      "annotations": [ # Citation information for model-generated content.
+        { # Citation information for model-generated content.
+          "endIndex": 42, # End of the attributed segment, exclusive.
+          "fileCitation": { # A file citation annotation. # A file citation annotation.
+            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+            "documentUri": "A String", # The URI of the file.
+            "fileName": "A String", # The name of the file.
+            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+            "pageNumber": 42, # Page number of the cited document, if applicable.
+            "source": "A String", # Source attributed for a portion of the text.
+          },
+          "placeCitation": { # A place citation annotation. # A place citation annotation.
+            "name": "A String", # Title of the place.
+            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                "reviewId": "A String", # The ID of the review snippet.
+                "title": "A String", # Title of the review.
+                "url": "A String", # A link that corresponds to the user review on Google Maps.
               },
-            },
+            ],
+            "url": "A String", # URI reference of the place.
+          },
+          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+            "title": "A String", # The title of the URL.
+            "url": "A String", # The URL.
+          },
+          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+            "startOffset": "A String", # Start offset in time of the word relative to 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.
+      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+      "processingConfig": {
+        "static": {
+          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+          "fps": 3.14, # Optional. Video frame-rate sampling density.
+          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+        },
+      },
+      "processingType": "A String",
+      "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.
+  "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction.
+    { # Error message from an interaction.
+      "code": "A String", # A URI that identifies the error type.
+      "message": "A String", # A human-readable error message.
+    },
+  ],
+  "id": "A String", # Required. Output only. A unique identifier for the interaction completion.
+  "labels": { # 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.
+      "stopSequences": [ # A list of character sequences that will stop output interaction.
+        "A String",
+      ],
+      "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration.
+        "speakers": [ # Individual speaker configurations.
+          { # 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.
+          },
+        ],
+      },
+      "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".
+        "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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.
+  },
+  "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",
           },
-          "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.
+        },
+      ],
+    },
+    "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 Cloud Storage, this is the Cloud Storage path. For GitHub, this is the GitHub path.
+        "target": "A String", # Where the source should appear in the environment.
+        "type": "A String",
+      },
+    ],
+  },
+  "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.
@@ -54425,920 +2917,693 @@ 

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, + "processingType": "A String", + "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 + }, + "listValue": { # `ListValue` is 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. - }, - ], + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "processingType": "A String", - "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. }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ + ], + }, + }, + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. + }, + }, + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. "reviewId": "A String", # The ID of the review snippet. "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - ], + "processingType": "A String", + "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 ], - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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`. + }, + "nullValue": "A String", # Represents a null value. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. # NOTE: We use these instead of the Citation message for historical reasons. 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. }, }, + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + "processingType": "A String", + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. + }, + }, + "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", + ], + "safetySettings": [ # 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. + }, + ], + "serviceTier": "A String", # The service tier for 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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": [ # 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. 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. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - "listValue": { # `ListValue` is 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. + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "serverName": "A String", # The name of the used MCP server. - }, - "processingResult": { # The result of a server-initiated media processing step. - }, - "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. - "isError": True or False, # Whether the retrieval resulted in an error. }, - "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. - }, - ], + ], + }, + "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`. }, }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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`. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. @@ -55350,136 +3615,202 @@

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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - ], + "processingType": "A String", + "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 ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "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", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, + "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. + "queries": [ # Queries for Retrieval information. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. }, + "processingType": "A String", + "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. }, - "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", + "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", + }, ], }, - "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", + "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. + }, ], - "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. + "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. @@ -55539,175 +3870,350 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + }, + "processingResult": { # The result of a server-initiated media processing step. + }, + "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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`. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. # NOTE: We use these instead of the Citation message for historical reasons. 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. + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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": [ # 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. @@ -55719,279 +4225,70 @@

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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "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. # NOTE: We use these instead of the Citation message for historical reasons. 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "processingType": "A String", - "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. - "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "apiKey": "A String", # Required. The API key for ExaAiSearch. - "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "apiKey": "A String", # Optional. The API key for ParallelAiSearch. - "customConfig": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "ragResources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadataFilter": "A String", # Optional. String for metadata filtering. - "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rankService": { # Config for Rank Service. # Config for Rank Service. - "modelName": "A String", # Optional. The model name of the rank service. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, - }, - "topK": 42, # Optional. The number of contexts to retrieve. - }, - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertexAiSearchConfig": { # 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. - }, - }, - ], - "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. - "findRequest": { # 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. - "findingId": "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. - "sourceFiles": [ # 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. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, ], }, - "fixRequest": { # 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. - "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. - "sourceFiles": [ # 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. - }, + "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", ], }, - "model": "A String", # The name of the model to use for the CodeMender agent. One CodeMender session will only use one model. - "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. - "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. - }, - "sessionId": "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. + "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. }, - "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. + "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", @@ -56055,267 +4352,6 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -56343,72 +4379,174 @@

Method Details

"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. + }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, + "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. + "queries": [ # Queries for Retrieval information. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -56454,126 +4592,193 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "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 ], }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. + "nullValue": "A String", # Represents a null value. + "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. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "serverName": "A String", # The name of the used MCP server. + }, + "processingResult": { # The result of a server-initiated media processing step. + }, + "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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. }, - }, + ], }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], + "processingType": "A String", + "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. - { + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -56585,167 +4790,243 @@

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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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 ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, + "nullValue": "A String", # Represents a null value. + "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", ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, + ], + "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. + "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. + "customConfig": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "ragResources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "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. + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rankService": { # Config for Rank Service. # Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, + "topK": 42, # Optional. The number of contexts to retrieve. }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertexAiSearchConfig": { # 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. }, }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. + "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. + }, + }, + ], + "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). + }, +}
+
+ +
+ createStream(projectsId, locationsId, body=None, x__xgafv=None) +
Creates an interaction and streams the response.
+
+Args:
+  projectsId: string, A parameter (required)
+  locationsId: string, A parameter (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Configuration parameters for creating an interaction.
+  "background": True or False, # Input only. Whether to run the model interaction in the background.
+  "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.
+        "findRequest": { # 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.
+          "findingId": "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.
+          "sourceFiles": [ # 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.
             },
-            "image": { # An image content block.
-              "data": "A String", # The image content.
-              "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
-              "resolution": "A String", # The resolution of the media.
-              "uri": "A String", # The URI of the image.
+          ],
+        },
+        "fixRequest": { # 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.
+          "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability.
+          "sourceFiles": [ # 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.
             },
-            "text": { # A text content block.
-              "annotations": [ # Citation information for model-generated content.
-                { # Citation information for model-generated content.
-                  "endIndex": 42, # End of the attributed segment, exclusive.
-                  "fileCitation": { # A file citation annotation. # A file citation annotation.
-                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
-                    "documentUri": "A String", # The URI of the file.
-                    "fileName": "A String", # The name of the file.
-                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                    "pageNumber": 42, # Page number of the cited document, if applicable.
-                    "source": "A String", # Source attributed for a portion of the text.
-                  },
-                  "placeCitation": { # A place citation annotation. # A place citation annotation.
-                    "name": "A String", # Title of the place.
-                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                        "reviewId": "A String", # The ID of the review snippet.
-                        "title": "A String", # Title of the review.
-                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                      },
-                    ],
-                    "url": "A String", # URI reference of the place.
-                  },
-                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                  "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
-                    "title": "A String", # The title of the URL.
-                    "url": "A String", # The URL.
+          ],
+        },
+        "model": "A String", # The name of the model to use for the CodeMender agent. One CodeMender session will only use one model.
+        "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior.
+          "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout.
+        },
+        "sessionId": "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.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "sampleRate": 42, # The sample rate of the audio.
+                    "uri": "A String", # The URI of the audio.
                   },
-                  "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
-                    "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
-                    "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
-                    "startOffset": "A String", # Start offset 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.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "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.
                     "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
@@ -56791,154 +5072,333 @@ 

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "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. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. + { # Error message from an interaction. + "code": "A String", # A URI that identifies the error type. + "message": "A String", # A human-readable error message. + }, + ], + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "labels": { # 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. + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. + "speakers": [ # Individual speaker configurations. + { # 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. + }, + ], + }, + "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". + "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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. + }, + "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 Cloud Storage, this is the Cloud Storage path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "processingType": "A String", + "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. + }, }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -56984,175 +5444,78 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - }, - "processingType": "A String", - "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. - "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. - { # Error message from an interaction. - "code": "A String", # A URI that identifies the error type. - "message": "A String", # A human-readable error message. - }, - ], - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "labels": { # 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. - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. - "speakers": [ # Individual speaker configurations. - { # 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. - }, - ], - }, - "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". - "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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. + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. }, }, - "model": "A String", # The name of the `Model` used for generating the completion. + ], + }, + "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. }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -57195,326 +5558,173 @@

Method Details

"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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - }, - "processingType": "A String", - "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", + "listValue": { # `ListValue` is 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. }, - ], - }, - "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 Cloud Storage, this is the Cloud Storage 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of 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": { # 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "nullValue": "A String", # Represents a null value. + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. + }, + }, + "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", + ], + "safetySettings": [ # 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. + }, + ], + "serviceTier": "A String", # The service tier for 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -57560,616 +5770,235 @@

Method Details

], "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user 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. + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], + "message": "A String", # A developer-facing error message, which should be 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. # NOTE: We use these instead of the Citation message for historical reasons. 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. + }, + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. - }, - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - }, - ], + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "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", @@ -58233,267 +6062,6 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -58523,35 +6091,158 @@

Method Details

}, ], }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, + "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. + "queries": [ # Queries for Retrieval information. + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. + "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. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. @@ -58611,267 +6302,6 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -58898,620 +6328,436 @@

Method Details

"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. }, - ], - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "processingResult": { # The result of a server-initiated media processing step. + }, + "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. # NOTE: We use these instead of the Citation message for historical reasons. 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "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. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - "processingType": "A String", - "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset 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. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + "processingType": "A String", + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. - "resolution": "A String", # The video output resolution. Defaults to 720p. - }, - }, - "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. - "safetySettings": [ # 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. + }, + ], }, - ], - "serviceTier": "A String", # The service tier for 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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. @@ -59523,1225 +6769,1273 @@

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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "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. # NOTE: We use these instead of the Citation message for historical reasons. 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, + "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. + "queries": [ # Queries for Retrieval information. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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 ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, + }, + "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. }, ], - "text": "A String", # Required. The text content. + "url": "A String", }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", + }, + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "processingType": "A String", + "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. + }, + "processingResult": { # The result of a server-initiated media processing step. + }, + "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. # NOTE: We use these instead of the Citation message for historical reasons. 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + }, + "processingType": "A String", + "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. + }, + }, + ], + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, + "processingType": "A String", + "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", ], }, - "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`. + ], + "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. + "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. + "customConfig": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "ragResources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rankService": { # Config for Rank Service. # Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. }, }, - "fileSearchCall": { # File Search call step. + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertexAiSearchConfig": { # 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. + }, + }, + ], + "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). + }, + }, + "store": True or False, # Input only. Whether to store the response and request for later retrieval. + "stream": True or False, # Input only. Whether the interaction will be streamed. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { + "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. + "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. + "findRequest": { # 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. + "findingId": "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. + "sourceFiles": [ # 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. }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. + ], + }, + "fixRequest": { # 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. + "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "sourceFiles": [ # 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. + "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "sessionId": "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # 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. # NOTE: We use these instead of the Citation message for historical reasons. 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - }, - ], + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. + { # Error message from an interaction. + "code": "A String", # A URI that identifies the error type. + "message": "A String", # A human-readable error message. + }, + ], + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "labels": { # 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. + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. + "speakers": [ # Individual speaker configurations. + { # 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. + }, + ], + }, + "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". + "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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. + }, + "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 Cloud Storage, this is the Cloud Storage path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - "listValue": { # `ListValue` is 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. + "processingType": "A String", + "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", - ], - }, - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "listValue": { # `ListValue` is 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. # NOTE: We use these instead of the Citation message for historical reasons. 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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 + }, + "listValue": { # `ListValue` is 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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. + }, + }, + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). - }, - "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. - "queries": [ # Queries for Retrieval information. - "A String", - ], + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "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", + "listValue": { # `ListValue` is 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. }, }, - "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. + ], + }, + "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. @@ -60791,20 +8085,265 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. + }, + }, + "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", + ], + "safetySettings": [ # 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. + }, + ], + "serviceTier": "A String", # The service tier for 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -60850,340 +8389,73 @@

Method Details

], "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user 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. + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "listValue": { # `ListValue` is 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. }, - "processingType": "A String", - "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. }, - "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", - }, - ], + "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", + ], + }, }, - "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 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. }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -61229,266 +8501,71 @@

Method Details

], "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user 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. + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "listValue": { # `ListValue` is 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. }, - "processingType": "A String", - "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. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - "processingResult": { # The result of a server-initiated media processing step. + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). }, - "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. + "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. @@ -61498,314 +8575,53 @@

Method Details

}, "document": { # A document content block. "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # 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. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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": [ # 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. # NOTE: We use these instead of the Citation message for historical reasons. 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. @@ -61823,244 +8639,187 @@

Method Details

"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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "listValue": { # `ListValue` is 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 text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. + ], + "widgetContextToken": "A String", }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. + ], + }, + "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. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. - { + "listValue": { # `ListValue` is 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. + }, + "processingResult": { # The result of a server-initiated media processing step. + }, + "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -62072,117 +8831,48 @@

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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "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. # NOTE: We use these instead of the Citation message for historical reasons. 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + "processingType": "A String", + "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. + "contentString": "A String", # The content of the step. A single string. }, }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. + ], + }, + "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. @@ -62241,266 +8931,93 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, + "processingType": "A String", + "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. + }, + ], + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. }, - ], - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. @@ -62594,267 +9111,6 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -62967,267 +9223,6 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -63343,273 +9338,12 @@

Method Details

"wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "startOffset": "A String", # Start offset in time of the word relative to 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. @@ -63729,267 +9463,6 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -64050,311 +9523,50 @@

Method Details

"mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. "uri": "A String", # The URI of the document. }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. # NOTE: We use these instead of the Citation message for historical reasons. 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. @@ -64392,338 +9604,77 @@

Method Details

"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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. # NOTE: We use these instead of the Citation message for historical reasons. 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. @@ -64820,341 +9771,398 @@

Method Details

}, "retrievalTypes": [ # The types of file retrieval to enable. "A String", - ], - "vertexAiSearchConfig": { # 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. - }, - }, - ], - "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", - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, + ], + "vertexAiSearchConfig": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", ], - "text": "A String", # Required. The text content. + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "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. + }, + }, + ], + "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. + }, + "codeMenderConfig": { # Configuration for the CodeMender agent. + "findRequest": { # 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. + "findingId": "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. + "sourceFiles": [ # 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. + }, + ], + }, + "fixRequest": { # 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. + "findingId": "A String", # The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability. + "sourceFiles": [ # 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. + "sessionConfig": { # The configuration of CodeMender sessions. # Optional session-specific configurations to override default agent behavior. + "maxRounds": 42, # The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout. + }, + "sessionId": "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, + "processingType": "A String", + "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. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image 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. # NOTE: We use these instead of the Citation message for historical reasons. 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. + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "errors": [ # Output only. Diagnostic faults / platform errors recorded on the interaction. + { # Error message from an interaction. + "code": "A String", # A URI that identifies the error type. + "message": "A String", # A human-readable error message. + }, + ], + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "labels": { # 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. + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "structuredSpeechConfig": { # Configuration for multi-speaker and speech generation. # Speech and multi-speaker configuration. + "speakers": [ # Individual speaker configurations. + { # 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. }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. - }, - ], + ], + }, + "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". + "languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to 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. + }, + "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", }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. + }, + ], + }, + "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 Cloud Storage, this is the Cloud Storage path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -65200,83 +10208,250 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. + }, + }, + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. }, - "processingType": "A String", - "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. - }, - }, - "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. + "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", @@ -65301,49 +10476,294 @@

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. # NOTE: We use these instead of the Citation message for historical reasons. 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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 Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI. + "resolution": "A String", # The video output resolution. Defaults to 720p. + }, + }, + "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", + ], + "safetySettings": [ # 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. + }, + ], + "serviceTier": "A String", # The service tier for 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -65389,375 +10809,313 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "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. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # 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. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, + "listValue": { # `ListValue` is 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. }, - "processingType": "A String", - "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. }, - ], - }, - "name": "A String", - "serverName": "A String", - }, - "processingCall": { # Streaming delta for a server-initiated media processing step. - }, - "retrievalCall": { # Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. - "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the Retrieval tool. - "queries": [ # Queries for Retrieval information. - "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. - }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, + "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. + "queries": [ # Queries for Retrieval information. + "A String", ], - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "retrievalType": "A String", # The type of retrieval tools. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. + "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", + ], + }, }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "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. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image 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 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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. - }, - ], - "url": "A String", # URI reference of the place. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. 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. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "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. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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", + }, ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -65803,369 +11161,239 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "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. }, + "serverName": "A String", # The name of the used MCP server. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "processingResult": { # The result of a server-initiated media processing step. + }, + "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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 - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + ], + }, + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "processingType": "A String", + "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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - }, - "processingType": "A String", - "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", - }, - "processingResult": { # Streaming delta for the result of a server-initiated media processing step. - }, - "retrievalResult": { # Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. ToolResultDelta.type - "isError": True or False, # Whether the retrieval resulted in an error. - }, - "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. - }, - ], - }, - }, - "text": { - "text": "A String", - }, - "textAnnotationDelta": { - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. + "contentString": "A String", # The content of the step. A single string. }, }, ], }, - "thoughtSignature": { - "signature": "A String", # Signature to match the backend source to be part of the generation. - }, - "thoughtSummary": { - "content": { # The content of the response. # A new summary item to be added to the thought. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. - }, - ], - "url": "A String", # URI reference of the place. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. 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. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time 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. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, ], - "text": "A String", # Required. The text content. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be 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 content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -66211,45 +11439,254 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. + "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 content. + "fileSearchCall": { # File Search call step. }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to 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", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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 content. + "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 content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web 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", + ], + }, + "searchType": "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, + "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. + "queries": [ # Queries for Retrieval information. "A String", ], }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the 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", @@ -66257,265 +11694,150 @@

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": [ # 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": { # 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. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": # Object with schema name: GenaiVertexV1beta1Struct - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - }, - "video": { - "data": "A String", - "mimeType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", - }, - }, - "index": 42, - }, - "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. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset 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. # NOTE: We use these instead of the Citation message for historical reasons. 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. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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", + }, ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -66561,126 +11883,193 @@

Method Details

], "text": "A String", # Required. The text content. }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "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 ], }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. + "nullValue": "A String", # Represents a null value. + "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. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "serverName": "A String", # The name of the used MCP server. + }, + "processingResult": { # The result of a server-initiated media processing step. + }, + "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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. }, - }, + ], }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of 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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], + "processingType": "A String", + "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. - { + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -66692,118 +12081,197 @@

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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, }, + "processingType": "A String", + "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 ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, + "nullValue": "A String", # Represents a null value. + "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", ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "text": "A String", # The transcribed word. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, + ], + "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. + "exaAiSearchConfig": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfig": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallelAiSearchConfig": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. + "customConfig": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "ragStoreConfig": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "ragResources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "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. + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rankService": { # Config for Rank Service. # Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, + "topK": 42, # Optional. The number of contexts to retrieve. }, - "processingType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, - }, - ], - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertexAiSearchConfig": { # 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. }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "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. + }, }, + ], + "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). }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. + }, + }, + "interactionStatusUpdate": { # The interaction status data, used for interaction.status_update events. + "interactionId": "A String", + "status": "A String", + }, + "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. @@ -66861,669 +12329,633 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + }, + }, + "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", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, + "processingType": "A String", + "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. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # 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", + "serverName": "A String", + }, + "processingCall": { # Streaming delta for a server-initiated media processing step. + }, + "retrievalCall": { # Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the Retrieval tool. + "queries": [ # Queries for Retrieval information. + "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. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + }, + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "fileSearchResult": { # File Search result content. - "result": [ # The results of the File Search. - { # The result of the File Search. - }, - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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 + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, - ], + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + }, + "serverName": "A String", + }, + "processingResult": { # Streaming delta for the result of a server-initiated media processing step. + }, + "retrievalResult": { # Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. ToolResultDelta.type + "isError": True or False, # Whether the retrieval resulted in an error. + }, + "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. + }, + ], + }, + }, + "text": { + "text": "A String", + }, + "textAnnotationDelta": { + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + }, + "thoughtSignature": { + "signature": "A String", # Signature to match the backend source to be part of the generation. + }, + "thoughtSummary": { + "content": { # The content of the response. # A new summary item to be added to the thought. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, - }, - "processingType": "A String", + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + }, + "video": { + "data": "A String", + "mimeType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", + }, + }, + "index": 42, + }, + "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. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "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`. - }, - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. - "processingConfig": { - "static": { - "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. - "fps": 3.14, # Optional. Video frame-rate sampling density. - "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "processingType": "A String", - "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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset 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. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - "nullValue": "A String", # Represents a null value. - "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. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, - ], + "processingType": "A String", + "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", @@ -67581,272 +13013,11 @@

Method Details

"endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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", # The transcribed word. }, - ], - }, + }, + ], + "text": "A String", # Required. The text content. }, "video": { # A video content block. "data": "A String", # The video content. @@ -67877,103 +13048,44 @@

Method Details

}, ], }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + "name": "A String", # Required. The name of the tool to call. }, - "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. + "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", ], }, - "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. + "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. }, - }, - "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. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset 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. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "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. "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. @@ -68019,217 +13131,127 @@

Method Details

], "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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. }, }, + "processingType": "A String", + "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 + "nullValue": "A String", # Represents a null value. + "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 content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL 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", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, + "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. + "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. + "queries": [ # Queries for Retrieval information. + "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. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to 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. @@ -68335,280 +13357,19 @@

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. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. 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. + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. @@ -68715,267 +13476,6 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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": [ # The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. - "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". - "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. - "startOffset": "A String", # Start offset in time of the word relative to 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. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.html index c25ad0c10a..8715419d88 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.html @@ -79,6 +79,9 @@

Instance Methods

Returns the analyzedSessions Resource.

+

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

+

Clears (purges) the trained model artifacts derived from a MonitoredAgent's data. The purged model is rebuilt by the next scheduled training run. To clear every MonitoredAgent in a location's scope, use the `-` wildcard agent segment for the name field: `projects/{project}/locations/{location}/monitoredAgents/-` This is the on-demand data-deletion path for customers who have deleted the underlying logs / observability data a model was trained on. It deletes only the derived model artifacts in the tenant project (it does NOT delete the scope, tenant project, or monitoring). To stop monitoring an agent entirely, disable it via DisableMonitoredAgent. See go/aad-clear-training-data.

close()

Close httplib2 connections.

@@ -98,6 +101,47 @@

Instance Methods

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

+
+ clearTrainingData(name, body=None, x__xgafv=None) +
Clears (purges) the trained model artifacts derived from a MonitoredAgent's data. The purged model is rebuilt by the next scheduled training run. To clear every MonitoredAgent in a location's scope, use the `-` wildcard agent segment for the name field: `projects/{project}/locations/{location}/monitoredAgents/-` This is the on-demand data-deletion path for customers who have deleted the underlying logs / observability data a model was trained on. It deletes only the derived model artifacts in the tenant project (it does NOT delete the scope, tenant project, or monitoring). To stop monitoring an agent entirely, disable it via DisableMonitoredAgent. See go/aad-clear-training-data.
+
+Args:
+  name: string, Required. The MonitoredAgent whose trained model artifacts to purge. Use the `-` wildcard agent segment to purge every MonitoredAgent in the scope. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for AgentAnomalyDetectionService.ClearTrainingData.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.events.html b/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.events.html index 10aeb841ce..05a870afb2 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.events.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.events.html @@ -95,8 +95,8 @@

Method Details

Args: parent: string, Required. The resource name of the A2ATaskRecord to list the TaskEvents under. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}` (required) - filter: string, Optional. The standard list filter. Supported fields: * `create_time` range (i.e. `create_time>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160). - orderBy: string, Optional. A comma-separated list of fields to order the results by. If this field is omitted, the results will be ordered by `generation` in ascending order. For each field, the default sort order is ascending. To specify descending order for a field, append a ` desc` suffix. For example: `create_time desc`. Supported fields: * `create_time` * `generation` + filter: string, Optional. The standard list filter. Supported fields: * `generation` * `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. Specifies the order of the returned events. If omitted, results default to `generation` in ascending order. To specify descending order, append a ` desc` suffix. For example: `generation desc`. Supported fields: * `generation` Note: Ordering directly by event timestamp (e.g., `create_time`) is not supported. Users requiring time-based traversal should use `generation` ordering and scan the results until the desired time threshold is reached (e.g., for chronological order, use default ascending and stop when `create_time` exceeds your target). pageSize: integer, Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. The maximum value is 100; values above 100 will be coerced to 100. pageToken: string, Optional. The next_page_token value returned from a previous list A2ATaskRecordService.ListA2ATaskRecordEvents call. x__xgafv: string, V1 error format. @@ -126,7 +126,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the artifact. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -151,7 +153,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the message. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -185,7 +189,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the message. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.html b/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.html index bfafb4f930..78a663295c 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.html @@ -129,7 +129,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the artifact. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -154,7 +156,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the message. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -188,7 +192,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the message. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -259,7 +265,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the artifact. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -288,7 +296,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the message. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -324,7 +334,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the message. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -372,7 +384,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the artifact. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -401,7 +415,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the message. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -437,7 +453,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the message. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -491,7 +509,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the artifact. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -520,7 +540,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the message. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -556,7 +578,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the message. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -615,7 +639,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the artifact. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -644,7 +670,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the message. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -680,7 +708,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the message. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -711,8 +741,8 @@

Method Details

Args: parent: string, Required. The resource name of the TaskStore to list the A2ATaskRecords under. Format: `projects/{project}/locations/{location}/taskStores/{task_store}` (required) - filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `context_id` * `status.state` Example: `context_id="abc"`, `status.state="WORKING"`. - orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. If this field is omitted, the default ordering is `create_time` descending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time` Example: `create_time desc`. + filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `task_id` * `context_id` * `status.state` * `app_id` * `user_id` * `create_time` range (i.e. `create_time>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) Example: `context_id="abc"`, `status.state="WORKING"`. + orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. If this field is omitted, the default ordering is `task_id` descending. More detail in [AIP-132](https://google.aip.dev/132). Supported field: * `task_id` * `create_time` Example: `create_time desc`, `task_id asc`. pageSize: integer, Optional. The maximum number of tasks to return. The service may return fewer than this value. If unspecified, at most 10 tasks will be returned. The maximum value is 100; values above 100 will be coerced to 100. pageToken: string, Optional. The next_page_token value returned from a previous list A2ATaskRecordService.ListA2ATaskRecords call. x__xgafv: string, V1 error format. @@ -740,7 +770,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the artifact. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -769,7 +801,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the message. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. @@ -805,7 +839,9 @@

Method Details

}, "parts": [ # Required. The content parts that make up the message. { # A single part of a message or artifact. A part carries exactly one kind of content. - "data": "", # Optional. Arbitrary data content. + "data": { # Optional. Arbitrary 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. diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index 0cf03a282d..9a9ce185ca 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -36679,7 +36679,7 @@ } } }, -"revision": "20260831", +"revision": "20260904", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { @@ -37831,7 +37831,7 @@ "type": "object" }, "name": { -"description": "Optional. The tool's GCP resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`.", +"description": "Optional. The tool's Google Cloud resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`.", "type": "string" }, "type": { diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index e67863957d..20077a8299 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -15240,6 +15240,168 @@ } } }, +"evaluationExperiments": { +"methods": { +"create": { +"description": "Creates an Evaluation Experiment.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationExperiments", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.evaluationExperiments.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location to create the Evaluation Experiment in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/evaluationExperiments", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1EvaluationExperiment" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1EvaluationExperiment" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes an Evaluation Experiment.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationExperiments/{evaluationExperimentsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.evaluationExperiments.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the EvaluationExperiment resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationExperiments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets an Evaluation Experiment.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationExperiments/{evaluationExperimentsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.evaluationExperiments.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the EvaluationExperiment resource. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationExperiments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1EvaluationExperiment" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Evaluation Experiments.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationExperiments", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.evaluationExperiments.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter expression that matches a subset of the EvaluationExperiments to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of Evaluation Experiments to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListEvaluationExperiments` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location from which to list the Evaluation Experiments. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/evaluationExperiments", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListEvaluationExperimentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates an Evaluation Experiment.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationExperiments/{evaluationExperimentsId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.evaluationExperiments.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationExperiments/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1EvaluationExperiment" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1EvaluationExperiment" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "evaluationItems": { "methods": { "create": { @@ -27198,6 +27360,34 @@ }, "monitoredAgents": { "methods": { +"clearTrainingData": { +"description": "Clears (purges) the trained model artifacts derived from a MonitoredAgent's data. The purged model is rebuilt by the next scheduled training run. To clear every MonitoredAgent in a location's scope, use the `-` wildcard agent segment for the name field: `projects/{project}/locations/{location}/monitoredAgents/-` This is the on-demand data-deletion path for customers who have deleted the underlying logs / observability data a model was trained on. It deletes only the derived model artifacts in the tenant project (it does NOT delete the scope, tenant project, or monitoring). To stop monitoring an agent entirely, disable it via DisableMonitoredAgent. See go/aad-clear-training-data.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}:clearTrainingData", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.monitoredAgents.clearTrainingData", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The MonitoredAgent whose trained model artifacts to purge. Use the `-` wildcard agent segment to purge every MonitoredAgent in the scope. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:clearTrainingData", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1ClearTrainingDataRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "disable": { "description": "Disables a specific MonitoredAgent.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}:disable", @@ -40222,12 +40412,12 @@ ], "parameters": { "filter": { -"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `context_id` * `status.state` Example: `context_id=\"abc\"`, `status.state=\"WORKING\"`.", +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `task_id` * `context_id` * `status.state` * `app_id` * `user_id` * `create_time` range (i.e. `create_time>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) Example: `context_id=\"abc\"`, `status.state=\"WORKING\"`.", "location": "query", "type": "string" }, "orderBy": { -"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. If this field is omitted, the default ordering is `create_time` descending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. If this field is omitted, the default ordering is `task_id` descending. More detail in [AIP-132](https://google.aip.dev/132). Supported field: * `task_id` * `create_time` Example: `create_time desc`, `task_id asc`.", "location": "query", "type": "string" }, @@ -40272,12 +40462,12 @@ ], "parameters": { "filter": { -"description": "Optional. The standard list filter. Supported fields: * `create_time` range (i.e. `create_time>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).", +"description": "Optional. The standard list filter. Supported fields: * `generation` * `create_time` range (i.e. `create_time>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "orderBy": { -"description": "Optional. A comma-separated list of fields to order the results by. If this field is omitted, the results will be ordered by `generation` in ascending order. For each field, the default sort order is ascending. To specify descending order for a field, append a ` desc` suffix. For example: `create_time desc`. Supported fields: * `create_time` * `generation`", +"description": "Optional. Specifies the order of the returned events. If omitted, results default to `generation` in ascending order. To specify descending order, append a ` desc` suffix. For example: `generation desc`. Supported fields: * `generation` Note: Ordering directly by event timestamp (e.g., `create_time`) is not supported. Users requiring time-based traversal should use `generation` ordering and scan the results until the desired time threshold is reached (e.g., for chronological order, use default ascending and stop when `create_time` exceeds your target).", "location": "query", "type": "string" }, @@ -50889,7 +51079,7 @@ } } }, -"revision": "20260831", +"revision": "20260904", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { @@ -51853,7 +52043,8 @@ "TYPE_L16", "TYPE_OPUS", "TYPE_ALAW", -"TYPE_MULAW" +"TYPE_MULAW", +"TYPE_WEBM" ], "enumDescriptions": [ "", @@ -51868,7 +52059,8 @@ "L16 audio format", "OPUS audio format", "ALAW audio format", -"MULAW audio format" +"MULAW audio format", +"WEBM audio format" ], "type": "string" }, @@ -51948,18 +52140,6 @@ "properties": {}, "type": "object" }, -"GenaiVertexV1beta1CodeExecutionCallContent": { -"deprecated": true, -"description": "Code execution content.", -"id": "GenaiVertexV1beta1CodeExecutionCallContent", -"properties": { -"arguments": { -"$ref": "GenaiVertexV1beta1CodeExecutionCallContentCodeExecutionCallArguments", -"description": "Required. The arguments to pass to the code execution." -} -}, -"type": "object" -}, "GenaiVertexV1beta1CodeExecutionCallContentCodeExecutionCallArguments": { "description": "The arguments to pass to the code execution.", "id": "GenaiVertexV1beta1CodeExecutionCallContentCodeExecutionCallArguments", @@ -52026,22 +52206,6 @@ }, "type": "object" }, -"GenaiVertexV1beta1CodeExecutionResultContent": { -"deprecated": true, -"description": "Code execution result content.", -"id": "GenaiVertexV1beta1CodeExecutionResultContent", -"properties": { -"isError": { -"description": "Whether the code execution resulted in an error.", -"type": "boolean" -}, -"result": { -"description": "Required. The output of the code execution.", -"type": "string" -} -}, -"type": "object" -}, "GenaiVertexV1beta1CodeExecutionResultDelta": { "id": "GenaiVertexV1beta1CodeExecutionResultDelta", "properties": { @@ -52258,74 +52422,12 @@ "text": { "$ref": "GenaiVertexV1beta1TextContent" }, -"thought": { -"$ref": "GenaiVertexV1beta1ThoughtContent", -"deprecated": true -}, -"toolCall": { -"$ref": "GenaiVertexV1beta1ToolCallContent", -"deprecated": true -}, -"toolResult": { -"$ref": "GenaiVertexV1beta1ToolResultContent", -"deprecated": true -}, "video": { "$ref": "GenaiVertexV1beta1VideoContent" } }, "type": "object" }, -"GenaiVertexV1beta1ContentDelta": { -"id": "GenaiVertexV1beta1ContentDelta", -"properties": { -"delta": { -"$ref": "GenaiVertexV1beta1ContentDeltaData" -}, -"index": { -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"GenaiVertexV1beta1ContentDeltaData": { -"description": "The delta content data for a content block.", -"id": "GenaiVertexV1beta1ContentDeltaData", -"properties": { -"audio": { -"$ref": "GenaiVertexV1beta1AudioDelta" -}, -"document": { -"$ref": "GenaiVertexV1beta1DocumentDelta" -}, -"image": { -"$ref": "GenaiVertexV1beta1ImageDelta" -}, -"text": { -"$ref": "GenaiVertexV1beta1TextDelta" -}, -"textAnnotation": { -"$ref": "GenaiVertexV1beta1TextAnnotationDelta" -}, -"thoughtSignature": { -"$ref": "GenaiVertexV1beta1ThoughtSignatureDelta" -}, -"thoughtSummary": { -"$ref": "GenaiVertexV1beta1ThoughtSummaryDelta" -}, -"toolCall": { -"$ref": "GenaiVertexV1beta1ToolCallDelta" -}, -"toolResult": { -"$ref": "GenaiVertexV1beta1ToolResultDelta" -}, -"video": { -"$ref": "GenaiVertexV1beta1VideoDelta" -} -}, -"type": "object" -}, "GenaiVertexV1beta1ContentList": { "description": "A list of Content.", "id": "GenaiVertexV1beta1ContentList", @@ -52340,29 +52442,6 @@ }, "type": "object" }, -"GenaiVertexV1beta1ContentStart": { -"id": "GenaiVertexV1beta1ContentStart", -"properties": { -"content": { -"$ref": "GenaiVertexV1beta1Content" -}, -"index": { -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"GenaiVertexV1beta1ContentStop": { -"id": "GenaiVertexV1beta1ContentStop", -"properties": { -"index": { -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, "GenaiVertexV1beta1CreateInteractionHttpRequest": { "description": "Request message for [InteractionsService.CreateInteractionHttp].", "id": "GenaiVertexV1beta1CreateInteractionHttpRequest", @@ -52719,13 +52798,6 @@ }, "type": "object" }, -"GenaiVertexV1beta1FileSearchCallContent": { -"deprecated": true, -"description": "File Search content.", -"id": "GenaiVertexV1beta1FileSearchCallContent", -"properties": {}, -"type": "object" -}, "GenaiVertexV1beta1FileSearchCallDelta": { "id": "GenaiVertexV1beta1FileSearchCallDelta", "properties": {}, @@ -52737,21 +52809,6 @@ "properties": {}, "type": "object" }, -"GenaiVertexV1beta1FileSearchResultContent": { -"deprecated": true, -"description": "File Search result content.", -"id": "GenaiVertexV1beta1FileSearchResultContent", -"properties": { -"result": { -"description": "The results of the File Search.", -"items": { -"$ref": "GenaiVertexV1beta1FileSearchResultContentFileSearchResult" -}, -"type": "array" -} -}, -"type": "object" -}, "GenaiVertexV1beta1FileSearchResultContentFileSearchResult": { "description": "The result of the File Search.", "id": "GenaiVertexV1beta1FileSearchResultContentFileSearchResult", @@ -52795,34 +52852,6 @@ }, "type": "object" }, -"GenaiVertexV1beta1FunctionCallContent": { -"deprecated": true, -"description": "A function tool call content block.", -"id": "GenaiVertexV1beta1FunctionCallContent", -"properties": { -"arguments": { -"$ref": "GenaiVertexV1beta1Struct", -"description": "Required. The arguments to pass to the function." -}, -"name": { -"description": "Required. The name of the tool to call.", -"type": "string" -} -}, -"type": "object" -}, -"GenaiVertexV1beta1FunctionCallDelta": { -"id": "GenaiVertexV1beta1FunctionCallDelta", -"properties": { -"arguments": { -"$ref": "GenaiVertexV1beta1Struct" -}, -"name": { -"type": "string" -} -}, -"type": "object" -}, "GenaiVertexV1beta1FunctionCallStep": { "description": "A function tool call step.", "id": "GenaiVertexV1beta1FunctionCallStep", @@ -52838,31 +52867,6 @@ }, "type": "object" }, -"GenaiVertexV1beta1FunctionResultContent": { -"deprecated": true, -"description": "A function tool result content block.", -"id": "GenaiVertexV1beta1FunctionResultContent", -"properties": { -"contentList": { -"$ref": "GenaiVertexV1beta1FunctionResultSubcontentList" -}, -"isError": { -"description": "Whether the tool call resulted in an error.", -"type": "boolean" -}, -"name": { -"description": "The name of the tool that was called.", -"type": "string" -}, -"stringResult": { -"type": "string" -}, -"structResult": { -"$ref": "GenaiVertexV1beta1Struct" -} -}, -"type": "object" -}, "GenaiVertexV1beta1FunctionResultDelta": { "id": "GenaiVertexV1beta1FunctionResultDelta", "properties": { @@ -52897,30 +52901,6 @@ }, "type": "object" }, -"GenaiVertexV1beta1FunctionResultSubcontent": { -"id": "GenaiVertexV1beta1FunctionResultSubcontent", -"properties": { -"image": { -"$ref": "GenaiVertexV1beta1ImageContent" -}, -"text": { -"$ref": "GenaiVertexV1beta1TextContent" -} -}, -"type": "object" -}, -"GenaiVertexV1beta1FunctionResultSubcontentList": { -"id": "GenaiVertexV1beta1FunctionResultSubcontentList", -"properties": { -"contents": { -"items": { -"$ref": "GenaiVertexV1beta1FunctionResultSubcontent" -}, -"type": "array" -} -}, -"type": "object" -}, "GenaiVertexV1beta1GenerationConfig": { "description": "Configuration parameters for model interactions.", "id": "GenaiVertexV1beta1GenerationConfig", @@ -53047,18 +53027,6 @@ }, "type": "object" }, -"GenaiVertexV1beta1GoogleMapsCallContent": { -"deprecated": true, -"description": "Google Maps content.", -"id": "GenaiVertexV1beta1GoogleMapsCallContent", -"properties": { -"arguments": { -"$ref": "GenaiVertexV1beta1GoogleMapsCallContentGoogleMapsCallArguments", -"description": "The arguments to pass to the Google Maps tool." -} -}, -"type": "object" -}, "GenaiVertexV1beta1GoogleMapsCallContentGoogleMapsCallArguments": { "description": "The arguments to pass to the Google Maps tool.", "id": "GenaiVertexV1beta1GoogleMapsCallContentGoogleMapsCallArguments", @@ -53108,21 +53076,6 @@ }, "type": "object" }, -"GenaiVertexV1beta1GoogleMapsResultContent": { -"deprecated": true, -"description": "Google Maps result content.", -"id": "GenaiVertexV1beta1GoogleMapsResultContent", -"properties": { -"result": { -"description": "Required. The results of the Google Maps.", -"items": { -"$ref": "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResult" -}, -"type": "array" -} -}, -"type": "object" -}, "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResult": { "description": "The result of the Google Maps.", "id": "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResult", @@ -53255,34 +53208,6 @@ }, "type": "object" }, -"GenaiVertexV1beta1GoogleSearchCallContent": { -"deprecated": true, -"description": "Google Search content.", -"id": "GenaiVertexV1beta1GoogleSearchCallContent", -"properties": { -"arguments": { -"$ref": "GenaiVertexV1beta1GoogleSearchCallContentGoogleSearchCallArguments", -"description": "Required. The arguments to pass to Google Search." -}, -"searchType": { -"description": "The type of search grounding enabled.", -"enum": [ -"SEARCH_TYPE_UNSPECIFIED", -"SEARCH_TYPE_WEB_SEARCH", -"SEARCH_TYPE_IMAGE_SEARCH", -"SEARCH_TYPE_ENTERPRISE_WEB_SEARCH" -], -"enumDescriptions": [ -"Unspecified search type. This value should not be used.", -"Setting this field enables web search. Only text results are returned.", -"Setting this field enables image search. Image bytes are returned.", -"Setting this field enables enterprise web search." -], -"type": "string" -} -}, -"type": "object" -}, "GenaiVertexV1beta1GoogleSearchCallContentGoogleSearchCallArguments": { "description": "The arguments to pass to Google Search.", "id": "GenaiVertexV1beta1GoogleSearchCallContentGoogleSearchCallArguments", @@ -53347,25 +53272,6 @@ }, "type": "object" }, -"GenaiVertexV1beta1GoogleSearchResultContent": { -"deprecated": true, -"description": "Google Search result content.", -"id": "GenaiVertexV1beta1GoogleSearchResultContent", -"properties": { -"isError": { -"description": "Whether the Google Search resulted in an error.", -"type": "boolean" -}, -"result": { -"description": "Required. The results of the Google Search.", -"items": { -"$ref": "GenaiVertexV1beta1GoogleSearchResultContentGoogleSearchResult" -}, -"type": "array" -} -}, -"type": "object" -}, "GenaiVertexV1beta1GoogleSearchResultContentGoogleSearchResult": { "description": "The result of the Google Search.", "id": "GenaiVertexV1beta1GoogleSearchResultContentGoogleSearchResult", @@ -53631,11 +53537,6 @@ "$ref": "GenaiVertexV1beta1Content", "description": "The content for the interaction." }, -"contentList": { -"$ref": "GenaiVertexV1beta1ContentList", -"deprecated": true, -"description": "The inputs for the interaction." -}, "created": { "description": "Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).", "readOnly": true, @@ -53678,15 +53579,6 @@ "$ref": "GenaiVertexV1beta1ModelInteraction", "description": "Interaction for generating the completion using models." }, -"outputs": { -"deprecated": true, -"description": "Output only. Responses from the model.", -"items": { -"$ref": "GenaiVertexV1beta1Content" -}, -"readOnly": true, -"type": "array" -}, "previousInteractionId": { "description": "The ID of the previous interaction, if any.", "type": "string" @@ -53694,11 +53586,6 @@ "remoteEnvironment": { "$ref": "GenaiVertexV1beta1EnvironmentConfig" }, -"responseFormat": { -"$ref": "GenaiVertexV1beta1Value", -"deprecated": true, -"description": "Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field." -}, "responseFormatList": { "$ref": "GenaiVertexV1beta1ResponseFormatList" }, @@ -53734,12 +53621,6 @@ }, "type": "array" }, -"role": { -"deprecated": true, -"description": "Output only. The role of the interaction.", -"readOnly": true, -"type": "string" -}, "safetySettings": { "description": "Safety settings for the interaction.", "items": { @@ -53832,17 +53713,6 @@ }, "type": "object" }, -"GenaiVertexV1beta1InteractionCompleteEvent": { -"deprecated": true, -"id": "GenaiVertexV1beta1InteractionCompleteEvent", -"properties": { -"interaction": { -"$ref": "GenaiVertexV1beta1Interaction", -"description": "Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output." -} -}, -"type": "object" -}, "GenaiVertexV1beta1InteractionCompletedSseEvent": { "id": "GenaiVertexV1beta1InteractionCompletedSseEvent", "properties": { @@ -53862,16 +53732,6 @@ }, "type": "object" }, -"GenaiVertexV1beta1InteractionStartEvent": { -"deprecated": true, -"id": "GenaiVertexV1beta1InteractionStartEvent", -"properties": { -"interaction": { -"$ref": "GenaiVertexV1beta1Interaction" -} -}, -"type": "object" -}, "GenaiVertexV1beta1InteractionStatusUpdate": { "id": "GenaiVertexV1beta1InteractionStatusUpdate", "properties": { @@ -53909,21 +53769,6 @@ "GenaiVertexV1beta1InteractionStreamingEvent": { "id": "GenaiVertexV1beta1InteractionStreamingEvent", "properties": { -"contentDelta": { -"$ref": "GenaiVertexV1beta1ContentDelta", -"deprecated": true, -"description": "The content block delta data, used for content.delta events. Legacy content-based streaming event, used when steps are disabled." -}, -"contentStart": { -"$ref": "GenaiVertexV1beta1ContentStart", -"deprecated": true, -"description": "The content block start data, used for content.start events. Legacy content-based streaming event, used when steps are disabled." -}, -"contentStop": { -"$ref": "GenaiVertexV1beta1ContentStop", -"deprecated": true, -"description": "The content block stop data, used for content.stop events. Legacy content-based streaming event, used when steps are disabled." -}, "errorEvent": { "$ref": "GenaiVertexV1beta1ErrorEvent", "description": "The error event data, used for error events." @@ -53932,11 +53777,6 @@ "description": "The event_id token to be used to resume the interaction stream, from this event.", "type": "string" }, -"interactionCompleteEvent": { -"$ref": "GenaiVertexV1beta1InteractionCompleteEvent", -"deprecated": true, -"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. Used when steps are enabled." @@ -53945,11 +53785,6 @@ "$ref": "GenaiVertexV1beta1InteractionCreatedSseEvent", "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. Legacy event, used when steps are disabled." -}, "interactionStatusUpdate": { "$ref": "GenaiVertexV1beta1InteractionStatusUpdate", "description": "The interaction status data, used for interaction.status_update events." @@ -54150,25 +53985,6 @@ }, "type": "object" }, -"GenaiVertexV1beta1McpServerToolCallContent": { -"description": "MCPServer tool call content.", -"id": "GenaiVertexV1beta1McpServerToolCallContent", -"properties": { -"arguments": { -"$ref": "GenaiVertexV1beta1Struct", -"description": "Required. The JSON object of arguments for the function." -}, -"name": { -"description": "Required. The name of the tool which was called.", -"type": "string" -}, -"serverName": { -"description": "Required. The name of the used MCP server.", -"type": "string" -} -}, -"type": "object" -}, "GenaiVertexV1beta1McpServerToolCallDelta": { "id": "GenaiVertexV1beta1McpServerToolCallDelta", "properties": { @@ -54203,30 +54019,6 @@ }, "type": "object" }, -"GenaiVertexV1beta1McpServerToolResultContent": { -"description": "MCPServer tool result content.", -"id": "GenaiVertexV1beta1McpServerToolResultContent", -"properties": { -"contentList": { -"$ref": "GenaiVertexV1beta1FunctionResultSubcontentList" -}, -"name": { -"description": "Name of the tool which is called for this specific tool call.", -"type": "string" -}, -"serverName": { -"description": "The name of the used MCP server.", -"type": "string" -}, -"stringResult": { -"type": "string" -}, -"structResult": { -"$ref": "GenaiVertexV1beta1Struct" -} -}, -"type": "object" -}, "GenaiVertexV1beta1McpServerToolResultDelta": { "id": "GenaiVertexV1beta1McpServerToolResultDelta", "properties": { @@ -55103,26 +54895,6 @@ false }, "type": "object" }, -"GenaiVertexV1beta1ThoughtContent": { -"deprecated": true, -"description": "A thought content block.", -"id": "GenaiVertexV1beta1ThoughtContent", -"properties": { -"signature": { -"description": "Signature to match the backend source to be part of the generation.", -"format": "byte", -"type": "string" -}, -"summary": { -"description": "A summary of the thought.", -"items": { -"$ref": "GenaiVertexV1beta1ThoughtSummaryContent" -}, -"type": "array" -} -}, -"type": "object" -}, "GenaiVertexV1beta1ThoughtSignatureDelta": { "id": "GenaiVertexV1beta1ThoughtSignatureDelta", "properties": { @@ -55153,18 +54925,6 @@ false }, "type": "object" }, -"GenaiVertexV1beta1ThoughtSummaryContent": { -"id": "GenaiVertexV1beta1ThoughtSummaryContent", -"properties": { -"image": { -"$ref": "GenaiVertexV1beta1ImageContent" -}, -"text": { -"$ref": "GenaiVertexV1beta1TextContent" -} -}, -"type": "object" -}, "GenaiVertexV1beta1ThoughtSummaryDelta": { "id": "GenaiVertexV1beta1ThoughtSummaryDelta", "properties": { @@ -55218,80 +54978,6 @@ false }, "type": "object" }, -"GenaiVertexV1beta1ToolCallContent": { -"deprecated": true, -"description": "Tool call content.", -"id": "GenaiVertexV1beta1ToolCallContent", -"properties": { -"codeExecutionCall": { -"$ref": "GenaiVertexV1beta1CodeExecutionCallContent" -}, -"fileSearchCall": { -"$ref": "GenaiVertexV1beta1FileSearchCallContent" -}, -"functionCall": { -"$ref": "GenaiVertexV1beta1FunctionCallContent" -}, -"googleMapsCall": { -"$ref": "GenaiVertexV1beta1GoogleMapsCallContent" -}, -"googleSearchCall": { -"$ref": "GenaiVertexV1beta1GoogleSearchCallContent" -}, -"id": { -"description": "Required. A unique ID for this specific tool call.", -"type": "string" -}, -"mcpServerToolCall": { -"$ref": "GenaiVertexV1beta1McpServerToolCallContent" -}, -"signature": { -"description": "A signature hash for backend validation.", -"format": "byte", -"type": "string" -}, -"urlContextCall": { -"$ref": "GenaiVertexV1beta1UrlContextCallContent" -} -}, -"type": "object" -}, -"GenaiVertexV1beta1ToolCallDelta": { -"id": "GenaiVertexV1beta1ToolCallDelta", -"properties": { -"codeExecutionCall": { -"$ref": "GenaiVertexV1beta1CodeExecutionCallDelta" -}, -"fileSearchCall": { -"$ref": "GenaiVertexV1beta1FileSearchCallDelta" -}, -"functionCall": { -"$ref": "GenaiVertexV1beta1FunctionCallDelta" -}, -"googleMapsCall": { -"$ref": "GenaiVertexV1beta1GoogleMapsCallDelta" -}, -"googleSearchCall": { -"$ref": "GenaiVertexV1beta1GoogleSearchCallDelta" -}, -"id": { -"description": "Required. A unique ID for this specific tool call.", -"type": "string" -}, -"mcpServerToolCall": { -"$ref": "GenaiVertexV1beta1McpServerToolCallDelta" -}, -"signature": { -"description": "A signature hash for backend validation.", -"format": "byte", -"type": "string" -}, -"urlContextCall": { -"$ref": "GenaiVertexV1beta1UrlContextCallDelta" -} -}, -"type": "object" -}, "GenaiVertexV1beta1ToolCallStep": { "description": "Tool call step.", "id": "GenaiVertexV1beta1ToolCallStep", @@ -55346,80 +55032,6 @@ false }, "type": "object" }, -"GenaiVertexV1beta1ToolResultContent": { -"deprecated": true, -"description": "Tool result content.", -"id": "GenaiVertexV1beta1ToolResultContent", -"properties": { -"callId": { -"description": "Required. ID to match the ID from the function call block.", -"type": "string" -}, -"codeExecutionResult": { -"$ref": "GenaiVertexV1beta1CodeExecutionResultContent" -}, -"fileSearchResult": { -"$ref": "GenaiVertexV1beta1FileSearchResultContent" -}, -"functionResult": { -"$ref": "GenaiVertexV1beta1FunctionResultContent" -}, -"googleMapsResult": { -"$ref": "GenaiVertexV1beta1GoogleMapsResultContent" -}, -"googleSearchResult": { -"$ref": "GenaiVertexV1beta1GoogleSearchResultContent" -}, -"mcpServerToolResult": { -"$ref": "GenaiVertexV1beta1McpServerToolResultContent" -}, -"signature": { -"description": "A signature hash for backend validation.", -"format": "byte", -"type": "string" -}, -"urlContextResult": { -"$ref": "GenaiVertexV1beta1UrlContextResultContent" -} -}, -"type": "object" -}, -"GenaiVertexV1beta1ToolResultDelta": { -"id": "GenaiVertexV1beta1ToolResultDelta", -"properties": { -"callId": { -"description": "Required. ID to match the ID from the function call block.", -"type": "string" -}, -"codeExecutionResult": { -"$ref": "GenaiVertexV1beta1CodeExecutionResultDelta" -}, -"fileSearchResult": { -"$ref": "GenaiVertexV1beta1FileSearchResultDelta" -}, -"functionResult": { -"$ref": "GenaiVertexV1beta1FunctionResultDelta" -}, -"googleMapsResult": { -"$ref": "GenaiVertexV1beta1GoogleMapsResultDelta" -}, -"googleSearchResult": { -"$ref": "GenaiVertexV1beta1GoogleSearchResultDelta" -}, -"mcpServerToolResult": { -"$ref": "GenaiVertexV1beta1McpServerToolResultDelta" -}, -"signature": { -"description": "A signature hash for backend validation.", -"format": "byte", -"type": "string" -}, -"urlContextResult": { -"$ref": "GenaiVertexV1beta1UrlContextResultDelta" -} -}, -"type": "object" -}, "GenaiVertexV1beta1ToolResultStep": { "description": "Tool result step.", "id": "GenaiVertexV1beta1ToolResultStep", @@ -55526,18 +55138,6 @@ false "properties": {}, "type": "object" }, -"GenaiVertexV1beta1UrlContextCallContent": { -"deprecated": true, -"description": "URL context content.", -"id": "GenaiVertexV1beta1UrlContextCallContent", -"properties": { -"arguments": { -"$ref": "GenaiVertexV1beta1UrlContextCallContentUrlContextCallArguments", -"description": "Required. The arguments to pass to the URL context." -} -}, -"type": "object" -}, "GenaiVertexV1beta1UrlContextCallContentUrlContextCallArguments": { "description": "The arguments to pass to the URL context.", "id": "GenaiVertexV1beta1UrlContextCallContentUrlContextCallArguments", @@ -55586,25 +55186,6 @@ false }, "type": "object" }, -"GenaiVertexV1beta1UrlContextResultContent": { -"deprecated": true, -"description": "URL context result content.", -"id": "GenaiVertexV1beta1UrlContextResultContent", -"properties": { -"isError": { -"description": "Whether the URL context resulted in an error.", -"type": "boolean" -}, -"result": { -"description": "Required. The results of the URL context.", -"items": { -"$ref": "GenaiVertexV1beta1UrlContextResultContentUrlContextResult" -}, -"type": "array" -} -}, -"type": "object" -}, "GenaiVertexV1beta1UrlContextResultContentUrlContextResult": { "description": "The result of the URL context.", "id": "GenaiVertexV1beta1UrlContextResultContentUrlContextResult", @@ -56065,9 +55646,13 @@ false "id": "GoogleCloudAiplatformV1beta1A2APart", "properties": { "data": { -"description": "Optional. Arbitrary data content.", +"additionalProperties": { +"description": "Properties of the object.", "type": "any" }, +"description": "Optional. Arbitrary data content.", +"type": "object" +}, "filename": { "description": "Optional. The name of the file, when the part represents a file.", "type": "string" @@ -57347,7 +56932,7 @@ false "type": "object" }, "name": { -"description": "Optional. The tool's GCP resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`.", +"description": "Optional. The tool's Google Cloud resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`.", "type": "string" }, "type": { @@ -60327,6 +59912,12 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ClearTrainingDataRequest": { +"description": "Request message for AgentAnomalyDetectionService.ClearTrainingData.", +"id": "GoogleCloudAiplatformV1beta1ClearTrainingDataRequest", +"properties": {}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ClientConnectionConfig": { "description": "Configurations (e.g. inference timeout) that are applied on your endpoints.", "id": "GoogleCloudAiplatformV1beta1ClientConnectionConfig", @@ -63413,6 +63004,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1DiscoveryEngineAssistantConfig": { +"description": "Config for scraping a Discovery Engine Assistant.", +"id": "GoogleCloudAiplatformV1beta1DiscoveryEngineAssistantConfig", +"properties": { +"assistant": { +"description": "Required. The resource name of the Discovery Engine Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`. For example: `projects/123/locations/global/collections/default_collection/engines/my-engine/assistants/default_assistant`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1DiskSpec": { "description": "Represents the spec of disk options.", "id": "GoogleCloudAiplatformV1beta1DiskSpec", @@ -64631,6 +64233,55 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1EvaluationExperiment": { +"description": "EvaluationExperiment is a resource that represents an experiment for iterating on and visualizing evaluation runs.", +"id": "GoogleCloudAiplatformV1beta1EvaluationExperiment", +"properties": { +"createTime": { +"description": "Output only. Timestamp when this experiment was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the evaluation experiment.", +"type": "string" +}, +"evaluationRuns": { +"description": "Required. The EvaluationRuns that are part of this experiment.", +"items": { +"type": "string" +}, +"type": "array" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels for the evaluation experiment.", +"type": "object" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Metadata about the evaluation experiment, can be used by the caller to store additional tracking information about the experiment.", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`", +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp when this experiment was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1EvaluationInstance": { "description": "A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations", "id": "GoogleCloudAiplatformV1beta1EvaluationInstance", @@ -65255,6 +64906,10 @@ false "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfig", "description": "Optional. The configuration used for the evaluation. Optional when analysis_configs is provided." }, +"evaluationExperiment": { +"description": "Optional. The resource name of the evaluation experiment for the evaluation run. Setting the evaluation experiment will add the run to the experiment. Multiple runs can be added to the same experiment. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`", +"type": "string" +}, "evaluationResults": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationResults", "description": "Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED.", @@ -65481,6 +65136,10 @@ false "description": "Optional. The resource name of the Agent Engine. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine} For example: projects/123/locations/us-central1/reasoningEngines/456", "type": "string" }, +"discoveryEngineAssistantConfig": { +"$ref": "GoogleCloudAiplatformV1beta1DiscoveryEngineAssistantConfig", +"description": "Optional. Config for scraping a Discovery Engine Assistant. The scraping service runs the assistant via the Discovery Engine AssistantService and returns the resulting trajectory for evaluation." +}, "geminiAgentConfig": { "$ref": "GoogleCloudAiplatformV1beta1GeminiAgentConfig", "description": "Optional. Config for scraping a Gemini Agent via the Interactions API. The scraping service creates interactions against the agent and returns the resulting interaction traces for evaluation." @@ -73823,6 +73482,24 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ListEvaluationExperimentsResponse": { +"description": "Response message for EvaluationManagementService.ListEvaluationExperiments.", +"id": "GoogleCloudAiplatformV1beta1ListEvaluationExperimentsResponse", +"properties": { +"evaluationExperiments": { +"description": "List of EvaluationExperiments in the requested page.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1EvaluationExperiment" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ListEvaluationItemsResponse": { "description": "Response message for EvaluationManagementService.ListEvaluationItems.", "id": "GoogleCloudAiplatformV1beta1ListEvaluationItemsResponse", From a856de7ac57f4a5706ae996fd7cedcfa2fe804e8 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:28 +0000 Subject: [PATCH 04/30] feat(analyticsdata): update the api #### analyticsdata:v1beta The following keys were added: - schemas.DataTruncationDateRange (Total Keys: 4) - schemas.DataTruncationReason (Total Keys: 7) - schemas.ResponseMetaData.properties.dataTruncationReasons (Total Keys: 2) --- docs/dyn/analyticsdata_v1beta.properties.html | 52 +++++++++++++ .../documents/analyticsdata.v1beta.json | 76 ++++++++++++++++++- 2 files changed, 127 insertions(+), 1 deletion(-) diff --git a/docs/dyn/analyticsdata_v1beta.properties.html b/docs/dyn/analyticsdata_v1beta.properties.html index 2893041982..5229fe05cf 100644 --- a/docs/dyn/analyticsdata_v1beta.properties.html +++ b/docs/dyn/analyticsdata_v1beta.properties.html @@ -390,6 +390,19 @@

Method Details

"metadata": { # Response's metadata carrying additional information about the report content. # Metadata for the report. "currencyCode": "A String", # The currency code used in this report. Intended to be used in formatting currency metrics like `purchaseRevenue` for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179. "dataLossFromOtherRow": True or False, # If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports. The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report. For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report. To learn more, see [About the (other) row and data sampling](https://support.google.com/analytics/answer/13208658#reports). + "dataTruncationReasons": [ # If set, indicate there is data truncation in the report. + { # Describes a reason for data truncation in the report. + "dataTruncationDate": "A String", # The data truncation date in the format YYYY-MM-DD. Indicates data before this date is truncated. + "dataTruncationDateRanges": [ # The truncated date ranges. + { # Define the truncated date range from start_date to end_date. + "endDate": "A String", # The end date in the format YYYY-MM-DD (inclusive). + "startDate": "A String", # The start date in the format YYYY-MM-DD (inclusive). + }, + ], + "dataTruncationMessage": "A String", # A descriptive message explaining the data truncation. + "dataTruncationType": "A String", # The type of data truncation. + }, + ], "emptyReason": "A String", # If empty reason is specified, the report is empty for this reason. "samplingMetadatas": [ # If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. One `samplingMetadatas` is populated for each date range. Each `samplingMetadatas` corresponds to a date range in order that date ranges were specified in the request. However if the results are not sampled, this field will not be defined. { # If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. Sampling is the practice of analyzing a subset of all data in order to uncover the meaningful information in the larger data set. @@ -754,6 +767,19 @@

Method Details

"metadata": { # Response's metadata carrying additional information about the report content. # Metadata for the report. "currencyCode": "A String", # The currency code used in this report. Intended to be used in formatting currency metrics like `purchaseRevenue` for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179. "dataLossFromOtherRow": True or False, # If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports. The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report. For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report. To learn more, see [About the (other) row and data sampling](https://support.google.com/analytics/answer/13208658#reports). + "dataTruncationReasons": [ # If set, indicate there is data truncation in the report. + { # Describes a reason for data truncation in the report. + "dataTruncationDate": "A String", # The data truncation date in the format YYYY-MM-DD. Indicates data before this date is truncated. + "dataTruncationDateRanges": [ # The truncated date ranges. + { # Define the truncated date range from start_date to end_date. + "endDate": "A String", # The end date in the format YYYY-MM-DD (inclusive). + "startDate": "A String", # The start date in the format YYYY-MM-DD (inclusive). + }, + ], + "dataTruncationMessage": "A String", # A descriptive message explaining the data truncation. + "dataTruncationType": "A String", # The type of data truncation. + }, + ], "emptyReason": "A String", # If empty reason is specified, the report is empty for this reason. "samplingMetadatas": [ # If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. One `samplingMetadatas` is populated for each date range. Each `samplingMetadatas` corresponds to a date range in order that date ranges were specified in the request. However if the results are not sampled, this field will not be defined. { # If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. Sampling is the practice of analyzing a subset of all data in order to uncover the meaningful information in the larger data set. @@ -1371,6 +1397,19 @@

Method Details

"metadata": { # Response's metadata carrying additional information about the report content. # Metadata for the report. "currencyCode": "A String", # The currency code used in this report. Intended to be used in formatting currency metrics like `purchaseRevenue` for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179. "dataLossFromOtherRow": True or False, # If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports. The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report. For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report. To learn more, see [About the (other) row and data sampling](https://support.google.com/analytics/answer/13208658#reports). + "dataTruncationReasons": [ # If set, indicate there is data truncation in the report. + { # Describes a reason for data truncation in the report. + "dataTruncationDate": "A String", # The data truncation date in the format YYYY-MM-DD. Indicates data before this date is truncated. + "dataTruncationDateRanges": [ # The truncated date ranges. + { # Define the truncated date range from start_date to end_date. + "endDate": "A String", # The end date in the format YYYY-MM-DD (inclusive). + "startDate": "A String", # The start date in the format YYYY-MM-DD (inclusive). + }, + ], + "dataTruncationMessage": "A String", # A descriptive message explaining the data truncation. + "dataTruncationType": "A String", # The type of data truncation. + }, + ], "emptyReason": "A String", # If empty reason is specified, the report is empty for this reason. "samplingMetadatas": [ # If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. One `samplingMetadatas` is populated for each date range. Each `samplingMetadatas` corresponds to a date range in order that date ranges were specified in the request. However if the results are not sampled, this field will not be defined. { # If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. Sampling is the practice of analyzing a subset of all data in order to uncover the meaningful information in the larger data set. @@ -1996,6 +2035,19 @@

Method Details

"metadata": { # Response's metadata carrying additional information about the report content. # Metadata for the report. "currencyCode": "A String", # The currency code used in this report. Intended to be used in formatting currency metrics like `purchaseRevenue` for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179. "dataLossFromOtherRow": True or False, # If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports. The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report. For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report. To learn more, see [About the (other) row and data sampling](https://support.google.com/analytics/answer/13208658#reports). + "dataTruncationReasons": [ # If set, indicate there is data truncation in the report. + { # Describes a reason for data truncation in the report. + "dataTruncationDate": "A String", # The data truncation date in the format YYYY-MM-DD. Indicates data before this date is truncated. + "dataTruncationDateRanges": [ # The truncated date ranges. + { # Define the truncated date range from start_date to end_date. + "endDate": "A String", # The end date in the format YYYY-MM-DD (inclusive). + "startDate": "A String", # The start date in the format YYYY-MM-DD (inclusive). + }, + ], + "dataTruncationMessage": "A String", # A descriptive message explaining the data truncation. + "dataTruncationType": "A String", # The type of data truncation. + }, + ], "emptyReason": "A String", # If empty reason is specified, the report is empty for this reason. "samplingMetadatas": [ # If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. One `samplingMetadatas` is populated for each date range. Each `samplingMetadatas` corresponds to a date range in order that date ranges were specified in the request. However if the results are not sampled, this field will not be defined. { # If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. Sampling is the practice of analyzing a subset of all data in order to uncover the meaningful information in the larger data set. diff --git a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json index c948abfa0b..70cd0a27c4 100644 --- a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json @@ -440,7 +440,7 @@ } } }, -"revision": "20241117", +"revision": "20260909", "rootUrl": "https://analyticsdata.googleapis.com/", "schemas": { "ActiveMetricRestriction": { @@ -846,6 +846,73 @@ }, "type": "object" }, +"DataTruncationDateRange": { +"description": "Define the truncated date range from start_date to end_date.", +"id": "DataTruncationDateRange", +"properties": { +"endDate": { +"description": "The end date in the format YYYY-MM-DD (inclusive).", +"type": "string" +}, +"startDate": { +"description": "The start date in the format YYYY-MM-DD (inclusive).", +"type": "string" +} +}, +"type": "object" +}, +"DataTruncationReason": { +"description": "Describes a reason for data truncation in the report.", +"id": "DataTruncationReason", +"properties": { +"dataTruncationDate": { +"description": "The data truncation date in the format YYYY-MM-DD. Indicates data before this date is truncated.", +"type": "string" +}, +"dataTruncationDateRanges": { +"description": "The truncated date ranges.", +"items": { +"$ref": "DataTruncationDateRange" +}, +"type": "array" +}, +"dataTruncationMessage": { +"description": "A descriptive message explaining the data truncation.", +"type": "string" +}, +"dataTruncationType": { +"description": "The type of data truncation.", +"enum": [ +"DATA_TRUNCATION_TYPE_UNSPECIFIED", +"DATA_TRUNCATION_TYPE_RULES_BASED_MODELS", +"DATA_TRUNCATION_TYPE_DATA_DRIVEN_ATTRIBUTION", +"DATA_TRUNCATION_TYPE_DV360", +"DATA_TRUNCATION_TYPE_CM360", +"DATA_TRUNCATION_TYPE_ITEM_SCOPED_ECOMMERCE_METRICS", +"DATA_TRUNCATION_TYPE_EVENT_SCOPED_ECOMMERCE_METRICS", +"DATA_TRUNCATION_TYPE_DATE_RANGE", +"DATA_TRUNCATION_TYPE_PROPERTY", +"DATA_TRUNCATION_TYPE_CONVERSIONS", +"DATA_TRUNCATION_TYPE_GOOGLE_ADS" +], +"enumDescriptions": [ +"Unspecified type.", +"Data is truncated in attribution report for rules-based models golden date.", +"Data is truncated in attribution report for data driven attribution golden date.", +"Data is truncated because DV360 policy does not permit data older than 2 years from being returned.", +"Data is truncated because CM360 policy does not permit data older than 2 years from being returned.", +"New item-scoped ecommerce metrics only have data after a specific date.", +"New event-scoped ecommerce metrics only have data after a specific date.", +"Query date range may not be fully served.", +"Data truncated because the query attempts to read event data prior to its retention date.", +"Data is truncated in conversions report.", +"Data is truncated due to Google Ads 36 month retention policy." +], +"type": "string" +} +}, +"type": "object" +}, "DateRange": { "description": "A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`. Requests are allowed up to 4 date ranges.", "id": "DateRange", @@ -1694,6 +1761,13 @@ "description": "If true, indicates some buckets of dimension combinations are rolled into \"(other)\" row. This can happen for high cardinality reports. The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report. For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report. To learn more, see [About the (other) row and data sampling](https://support.google.com/analytics/answer/13208658#reports).", "type": "boolean" }, +"dataTruncationReasons": { +"description": "If set, indicate there is data truncation in the report.", +"items": { +"$ref": "DataTruncationReason" +}, +"type": "array" +}, "emptyReason": { "description": "If empty reason is specified, the report is empty for this reason.", "type": "string" From dcf39623e3b058e72423e4210e54c0dc1bd7e20c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:28 +0000 Subject: [PATCH 05/30] feat(apigee): update the api #### apigee:v1 The following keys were added: - schemas.GoogleCloudApigeeV1ControlPlaneAccess.properties.watcherIdentities (Total Keys: 2) The following keys were changed: - endpoints (Total Keys: 1) --- docs/dyn/apigee_v1.organizations.html | 10 ++++++++-- .../discovery_cache/documents/apigee.v1.json | 16 ++++++++++++++-- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/docs/dyn/apigee_v1.organizations.html b/docs/dyn/apigee_v1.organizations.html index 5c173d0497..d40800675e 100644 --- a/docs/dyn/apigee_v1.organizations.html +++ b/docs/dyn/apigee_v1.organizations.html @@ -227,7 +227,7 @@

Instance Methods

Creates an Apigee organization. See [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org).

delete(name, retention=None, x__xgafv=None)

-

Delete an Apigee organization. For organizations with BillingType EVALUATION, an immediate deletion is performed. For paid organizations (Subscription or Pay-as-you-go), a soft-deletion is performed. The organization can be restored within the soft-deletion period, which is specified using the `retention` field in the request or by filing a support ticket with Apigee. During the data retention period specified in the request, the Apigee organization cannot be recreated in the same Google Cloud project. **IMPORTANT: The default data retention setting for this operation is 7 days. To permanently delete the organization in 24 hours, set the retention parameter to `MINIMUM`.**

+

Delete an Apigee organization. For organizations with BillingType EVALUATION, an immediate deletion is performed. For paid organizations (Subscription or Pay-as-you-go), a soft-deletion is performed by default. The organization can be restored within the soft-deletion period, which is specified using the `retention` field in the request or by filing a support ticket with Apigee. During the data retention period specified in the request, the Apigee organization cannot be recreated in the same Google Cloud project. **IMPORTANT: The default data retention setting for this operation is 7 days. To permanently delete the organization in 24 hours, set the retention parameter to `MINIMUM`.**

get(name, x__xgafv=None)

Gets the profile for an Apigee organization. See [Understanding organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure).

@@ -386,7 +386,7 @@

Method Details

delete(name, retention=None, x__xgafv=None) -
Delete an Apigee organization. For organizations with BillingType EVALUATION, an immediate deletion is performed. For paid organizations (Subscription or Pay-as-you-go), a soft-deletion is performed. The organization can be restored within the soft-deletion period, which is specified using the `retention` field in the request or by filing a support ticket with Apigee. During the data retention period specified in the request, the Apigee organization cannot be recreated in the same Google Cloud project. **IMPORTANT: The default data retention setting for this operation is 7 days. To permanently delete the organization in 24 hours, set the retention parameter to `MINIMUM`.**
+  
Delete an Apigee organization. For organizations with BillingType EVALUATION, an immediate deletion is performed. For paid organizations (Subscription or Pay-as-you-go), a soft-deletion is performed by default. The organization can be restored within the soft-deletion period, which is specified using the `retention` field in the request or by filing a support ticket with Apigee. During the data retention period specified in the request, the Apigee organization cannot be recreated in the same Google Cloud project. **IMPORTANT: The default data retention setting for this operation is 7 days. To permanently delete the organization in 24 hours, set the retention parameter to `MINIMUM`.**
 
 Args:
   name: string, Required. Name of the organization. Use the following structure in your request: `organizations/{org}` (required)
@@ -530,6 +530,9 @@ 

Method Details

"synchronizerIdentities": [ # Optional. Array of service accounts to grant access to control plane resources (for the Synchronizer component). The service accounts must have **Apigee Synchronizer Manager** role. See also [Create service accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts). "A String", ], + "watcherIdentities": [ # Optional. Service accounts granted access to control plane resources for the apigee-watcher component. + "A String", + ], }
@@ -1010,6 +1013,9 @@

Method Details

"synchronizerIdentities": [ # Optional. Array of service accounts to grant access to control plane resources (for the Synchronizer component). The service accounts must have **Apigee Synchronizer Manager** role. See also [Create service accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts). "A String", ], + "watcherIdentities": [ # Optional. Service accounts granted access to control plane resources for the apigee-watcher component. + "A String", + ], } updateMask: string, List of fields to be updated. Fields that can be updated: synchronizer_identities, analytics_publisher_identities, watcher_identities. diff --git a/googleapiclient/discovery_cache/documents/apigee.v1.json b/googleapiclient/discovery_cache/documents/apigee.v1.json index cb896abab9..7989f9a872 100644 --- a/googleapiclient/discovery_cache/documents/apigee.v1.json +++ b/googleapiclient/discovery_cache/documents/apigee.v1.json @@ -35,6 +35,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://apigee.sa.rep.googleapis.com/", "location": "sa" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://apigee.ch.rep.googleapis.com/", +"location": "ch" } ], "fullyEncodeReservedExpansion": true, @@ -187,7 +192,7 @@ ] }, "delete": { -"description": "Delete an Apigee organization. For organizations with BillingType EVALUATION, an immediate deletion is performed. For paid organizations (Subscription or Pay-as-you-go), a soft-deletion is performed. The organization can be restored within the soft-deletion period, which is specified using the `retention` field in the request or by filing a support ticket with Apigee. During the data retention period specified in the request, the Apigee organization cannot be recreated in the same Google Cloud project. **IMPORTANT: The default data retention setting for this operation is 7 days. To permanently delete the organization in 24 hours, set the retention parameter to `MINIMUM`.**", +"description": "Delete an Apigee organization. For organizations with BillingType EVALUATION, an immediate deletion is performed. For paid organizations (Subscription or Pay-as-you-go), a soft-deletion is performed by default. The organization can be restored within the soft-deletion period, which is specified using the `retention` field in the request or by filing a support ticket with Apigee. During the data retention period specified in the request, the Apigee organization cannot be recreated in the same Google Cloud project. **IMPORTANT: The default data retention setting for this operation is 7 days. To permanently delete the organization in 24 hours, set the retention parameter to `MINIMUM`.**", "flatPath": "v1/organizations/{organizationsId}", "httpMethod": "DELETE", "id": "apigee.organizations.delete", @@ -11989,7 +11994,7 @@ } } }, -"revision": "20260827", +"revision": "20260905", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -14078,6 +14083,13 @@ "type": "string" }, "type": "array" +}, +"watcherIdentities": { +"description": "Optional. Service accounts granted access to control plane resources for the apigee-watcher component.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" From d922d33d502250ad0cf6c89ff8e9785d5e3307f5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:28 +0000 Subject: [PATCH 06/30] feat(apihub): update the api #### apihub:v1 The following keys were added: - schemas.GoogleCloudApihubV1ApiOperation.properties.deployments (Total Keys: 2) - schemas.GoogleCloudApihubV1Deployment.properties.apiOperations (Total Keys: 3) - schemas.GoogleCloudApihubV1Deployment.properties.specs (Total Keys: 3) - schemas.GoogleCloudApihubV1Spec.properties.deployments (Total Keys: 2) - schemas.GoogleCloudApihubV1SpecMetadata.properties.deploymentResourceUris (Total Keys: 2) --- ...ts.locations.apis.versions.operations.html | 18 ++++++++ ...rojects.locations.apis.versions.specs.html | 18 ++++++++ ...hub_v1.projects.locations.deployments.html | 42 ++++++++++++++++++ docs/dyn/apihub_v1.projects.locations.html | 43 +++++++++++++++++++ .../discovery_cache/documents/apihub.v1.json | 43 ++++++++++++++++++- 5 files changed, 163 insertions(+), 1 deletion(-) diff --git a/docs/dyn/apihub_v1.projects.locations.apis.versions.operations.html b/docs/dyn/apihub_v1.projects.locations.apis.versions.operations.html index ac5589a344..2dcc0cc5c0 100644 --- a/docs/dyn/apihub_v1.projects.locations.apis.versions.operations.html +++ b/docs/dyn/apihub_v1.projects.locations.apis.versions.operations.html @@ -142,6 +142,9 @@

Method Details

}, }, "createTime": "A String", # Output only. The time at which the operation was created. + "deployments": [ # Optional. The deployments linked directly to this API operation. For operations parsed from a spec, `UpdateApiOperation` returns `FAILED_PRECONDITION`; link the parent spec to the deployment via `Spec.deployments` instead. Format is `projects/{project}/locations/{location}/deployments/{deployment}` + "A String", + ], "details": { # The operation details parsed from the spec. # Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided. "deprecated": True or False, # Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec. "description": "A String", # Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used. @@ -239,6 +242,9 @@

Method Details

}, }, "createTime": "A String", # Output only. The time at which the operation was created. + "deployments": [ # Optional. The deployments linked directly to this API operation. For operations parsed from a spec, `UpdateApiOperation` returns `FAILED_PRECONDITION`; link the parent spec to the deployment via `Spec.deployments` instead. Format is `projects/{project}/locations/{location}/deployments/{deployment}` + "A String", + ], "details": { # The operation details parsed from the spec. # Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided. "deprecated": True or False, # Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec. "description": "A String", # Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used. @@ -360,6 +366,9 @@

Method Details

}, }, "createTime": "A String", # Output only. The time at which the operation was created. + "deployments": [ # Optional. The deployments linked directly to this API operation. For operations parsed from a spec, `UpdateApiOperation` returns `FAILED_PRECONDITION`; link the parent spec to the deployment via `Spec.deployments` instead. Format is `projects/{project}/locations/{location}/deployments/{deployment}` + "A String", + ], "details": { # The operation details parsed from the spec. # Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided. "deprecated": True or False, # Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec. "description": "A String", # Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used. @@ -468,6 +477,9 @@

Method Details

}, }, "createTime": "A String", # Output only. The time at which the operation was created. + "deployments": [ # Optional. The deployments linked directly to this API operation. For operations parsed from a spec, `UpdateApiOperation` returns `FAILED_PRECONDITION`; link the parent spec to the deployment via `Spec.deployments` instead. Format is `projects/{project}/locations/{location}/deployments/{deployment}` + "A String", + ], "details": { # The operation details parsed from the spec. # Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided. "deprecated": True or False, # Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec. "description": "A String", # Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used. @@ -583,6 +595,9 @@

Method Details

}, }, "createTime": "A String", # Output only. The time at which the operation was created. + "deployments": [ # Optional. The deployments linked directly to this API operation. For operations parsed from a spec, `UpdateApiOperation` returns `FAILED_PRECONDITION`; link the parent spec to the deployment via `Spec.deployments` instead. Format is `projects/{project}/locations/{location}/deployments/{deployment}` + "A String", + ], "details": { # The operation details parsed from the spec. # Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided. "deprecated": True or False, # Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec. "description": "A String", # Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used. @@ -680,6 +695,9 @@

Method Details

}, }, "createTime": "A String", # Output only. The time at which the operation was created. + "deployments": [ # Optional. The deployments linked directly to this API operation. For operations parsed from a spec, `UpdateApiOperation` returns `FAILED_PRECONDITION`; link the parent spec to the deployment via `Spec.deployments` instead. Format is `projects/{project}/locations/{location}/deployments/{deployment}` + "A String", + ], "details": { # The operation details parsed from the spec. # Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided. "deprecated": True or False, # Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec. "description": "A String", # Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used. diff --git a/docs/dyn/apihub_v1.projects.locations.apis.versions.specs.html b/docs/dyn/apihub_v1.projects.locations.apis.versions.specs.html index a6d86d095b..70d87af9d8 100644 --- a/docs/dyn/apihub_v1.projects.locations.apis.versions.specs.html +++ b/docs/dyn/apihub_v1.projects.locations.apis.versions.specs.html @@ -169,6 +169,9 @@

Method Details

"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. }, "createTime": "A String", # Output only. The time at which the spec was created. + "deployments": [ # Optional. The deployments linked directly to this spec. Format is `projects/{project}/locations/{location}/deployments/{deployment}` + "A String", + ], "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec. "description": "A String", # Output only. The description of the spec. "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method. @@ -321,6 +324,9 @@

Method Details

"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. }, "createTime": "A String", # Output only. The time at which the spec was created. + "deployments": [ # Optional. The deployments linked directly to this spec. Format is `projects/{project}/locations/{location}/deployments/{deployment}` + "A String", + ], "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec. "description": "A String", # Output only. The description of the spec. "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method. @@ -532,6 +538,9 @@

Method Details

"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. }, "createTime": "A String", # Output only. The time at which the spec was created. + "deployments": [ # Optional. The deployments linked directly to this spec. Format is `projects/{project}/locations/{location}/deployments/{deployment}` + "A String", + ], "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec. "description": "A String", # Output only. The description of the spec. "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method. @@ -740,6 +749,9 @@

Method Details

"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. }, "createTime": "A String", # Output only. The time at which the spec was created. + "deployments": [ # Optional. The deployments linked directly to this spec. Format is `projects/{project}/locations/{location}/deployments/{deployment}` + "A String", + ], "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec. "description": "A String", # Output only. The description of the spec. "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method. @@ -909,6 +921,9 @@

Method Details

"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. }, "createTime": "A String", # Output only. The time at which the spec was created. + "deployments": [ # Optional. The deployments linked directly to this spec. Format is `projects/{project}/locations/{location}/deployments/{deployment}` + "A String", + ], "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec. "description": "A String", # Output only. The description of the spec. "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method. @@ -1061,6 +1076,9 @@

Method Details

"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. }, "createTime": "A String", # Output only. The time at which the spec was created. + "deployments": [ # Optional. The deployments linked directly to this spec. Format is `projects/{project}/locations/{location}/deployments/{deployment}` + "A String", + ], "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec. "description": "A String", # Output only. The description of the spec. "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method. diff --git a/docs/dyn/apihub_v1.projects.locations.deployments.html b/docs/dyn/apihub_v1.projects.locations.deployments.html index 3cd6fcbcca..e6c404b074 100644 --- a/docs/dyn/apihub_v1.projects.locations.deployments.html +++ b/docs/dyn/apihub_v1.projects.locations.deployments.html @@ -111,6 +111,9 @@

Method Details

The object takes the form of: { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. + "apiOperations": [ # Output only. The API operations linked directly to this deployment. + "A String", + ], "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). "A String", ], @@ -281,6 +284,7 @@

Method Details

}, ], "sourceProject": "A String", # Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. + "sourceRevision": "A String", # Optional. A revision identifier for the underlying gateway configuration that this deployment serves. For Apigee gateway variants, this is typically the proxy revision number populated automatically when the deployment is discovered. "sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -309,6 +313,9 @@

Method Details

], }, }, + "specs": [ # Output only. The specs linked directly to this deployment. Note: a deployment could serve multiple specs (e.g., across different revisions of the same underlying gateway configuration). + "A String", + ], "updateTime": "A String", # Output only. The time at which the deployment was last updated. } @@ -322,6 +329,9 @@

Method Details

An object of the form: { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. + "apiOperations": [ # Output only. The API operations linked directly to this deployment. + "A String", + ], "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). "A String", ], @@ -492,6 +502,7 @@

Method Details

}, ], "sourceProject": "A String", # Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. + "sourceRevision": "A String", # Optional. A revision identifier for the underlying gateway configuration that this deployment serves. For Apigee gateway variants, this is typically the proxy revision number populated automatically when the deployment is discovered. "sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -520,6 +531,9 @@

Method Details

], }, }, + "specs": [ # Output only. The specs linked directly to this deployment. Note: a deployment could serve multiple specs (e.g., across different revisions of the same underlying gateway configuration). + "A String", + ], "updateTime": "A String", # Output only. The time at which the deployment was last updated. }
@@ -557,6 +571,9 @@

Method Details

An object of the form: { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. + "apiOperations": [ # Output only. The API operations linked directly to this deployment. + "A String", + ], "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). "A String", ], @@ -727,6 +744,7 @@

Method Details

}, ], "sourceProject": "A String", # Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. + "sourceRevision": "A String", # Optional. A revision identifier for the underlying gateway configuration that this deployment serves. For Apigee gateway variants, this is typically the proxy revision number populated automatically when the deployment is discovered. "sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -755,6 +773,9 @@

Method Details

], }, }, + "specs": [ # Output only. The specs linked directly to this deployment. Note: a deployment could serve multiple specs (e.g., across different revisions of the same underlying gateway configuration). + "A String", + ], "updateTime": "A String", # Output only. The time at which the deployment was last updated. } @@ -779,6 +800,9 @@

Method Details

{ # The ListDeployments method's response. "deployments": [ # The deployment resources present in the API hub. { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. + "apiOperations": [ # Output only. The API operations linked directly to this deployment. + "A String", + ], "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). "A String", ], @@ -949,6 +973,7 @@

Method Details

}, ], "sourceProject": "A String", # Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. + "sourceRevision": "A String", # Optional. A revision identifier for the underlying gateway configuration that this deployment serves. For Apigee gateway variants, this is typically the proxy revision number populated automatically when the deployment is discovered. "sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -977,6 +1002,9 @@

Method Details

], }, }, + "specs": [ # Output only. The specs linked directly to this deployment. Note: a deployment could serve multiple specs (e.g., across different revisions of the same underlying gateway configuration). + "A String", + ], "updateTime": "A String", # Output only. The time at which the deployment was last updated. }, ], @@ -1008,6 +1036,9 @@

Method Details

The object takes the form of: { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. + "apiOperations": [ # Output only. The API operations linked directly to this deployment. + "A String", + ], "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). "A String", ], @@ -1178,6 +1209,7 @@

Method Details

}, ], "sourceProject": "A String", # Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. + "sourceRevision": "A String", # Optional. A revision identifier for the underlying gateway configuration that this deployment serves. For Apigee gateway variants, this is typically the proxy revision number populated automatically when the deployment is discovered. "sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -1206,6 +1238,9 @@

Method Details

], }, }, + "specs": [ # Output only. The specs linked directly to this deployment. Note: a deployment could serve multiple specs (e.g., across different revisions of the same underlying gateway configuration). + "A String", + ], "updateTime": "A String", # Output only. The time at which the deployment was last updated. } @@ -1219,6 +1254,9 @@

Method Details

An object of the form: { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. + "apiOperations": [ # Output only. The API operations linked directly to this deployment. + "A String", + ], "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). "A String", ], @@ -1389,6 +1427,7 @@

Method Details

}, ], "sourceProject": "A String", # Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. + "sourceRevision": "A String", # Optional. A revision identifier for the underlying gateway configuration that this deployment serves. For Apigee gateway variants, this is typically the proxy revision number populated automatically when the deployment is discovered. "sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -1417,6 +1456,9 @@

Method Details

], }, }, + "specs": [ # Output only. The specs linked directly to this deployment. Note: a deployment could serve multiple specs (e.g., across different revisions of the same underlying gateway configuration). + "A String", + ], "updateTime": "A String", # Output only. The time at which the deployment was last updated. } diff --git a/docs/dyn/apihub_v1.projects.locations.html b/docs/dyn/apihub_v1.projects.locations.html index 4d844a707c..7301a3fef3 100644 --- a/docs/dyn/apihub_v1.projects.locations.html +++ b/docs/dyn/apihub_v1.projects.locations.html @@ -488,6 +488,9 @@

Method Details

"deployments": [ # Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc.) { # The metadata associated with a deployment. "deployment": { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. # Required. The deployment resource to be pushed to Hub's collect layer. The ID of the deployment will be generated by Hub. + "apiOperations": [ # Output only. The API operations linked directly to this deployment. + "A String", + ], "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). "A String", ], @@ -658,6 +661,7 @@

Method Details

}, ], "sourceProject": "A String", # Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. + "sourceRevision": "A String", # Optional. A revision identifier for the underlying gateway configuration that this deployment serves. For Apigee gateway variants, this is typically the proxy revision number populated automatically when the deployment is discovered. "sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -686,6 +690,9 @@

Method Details

], }, }, + "specs": [ # Output only. The specs linked directly to this deployment. Note: a deployment could serve multiple specs (e.g., across different revisions of the same underlying gateway configuration). + "A String", + ], "updateTime": "A String", # Output only. The time at which the deployment was last updated. }, "originalCreateTime": "A String", # Optional. Timestamp indicating when the deployment was created at the source. @@ -698,6 +705,9 @@

Method Details

"originalUpdateTime": "A String", # Required. Timestamp indicating when the version was last updated at the source. "specs": [ # Optional. The specs associated with this version. Note that an API version can be associated with multiple specs. { # The metadata associated with a spec of the API version. + "deploymentResourceUris": [ # Optional. The gateway-side URIs of deployments that serve this spec. If provided, the API Hub service creates links between this spec and the deployments identified by these URIs. URIs that don't match any known deployment are ignored; a subsequent ingestion cycle that includes the missing deployment will re-establish the link. The maximum number of URIs allowed is 100. + "A String", + ], "originalCreateTime": "A String", # Optional. Timestamp indicating when the spec was created at the source. "originalId": "A String", # Optional. The unique identifier of the spec in the system where it was originally created. "originalUpdateTime": "A String", # Required. Timestamp indicating when the spec was last updated at the source. @@ -751,6 +761,9 @@

Method Details

"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. }, "createTime": "A String", # Output only. The time at which the spec was created. + "deployments": [ # Optional. The deployments linked directly to this spec. Format is `projects/{project}/locations/{location}/deployments/{deployment}` + "A String", + ], "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec. "description": "A String", # Output only. The description of the spec. "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method. @@ -1445,6 +1458,9 @@

Method Details

], }, "deployment": { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. # Optional. The deployment. + "apiOperations": [ # Output only. The API operations linked directly to this deployment. + "A String", + ], "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). "A String", ], @@ -1615,6 +1631,7 @@

Method Details

}, ], "sourceProject": "A String", # Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. + "sourceRevision": "A String", # Optional. A revision identifier for the underlying gateway configuration that this deployment serves. For Apigee gateway variants, this is typically the proxy revision number populated automatically when the deployment is discovered. "sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -1643,6 +1660,9 @@

Method Details

], }, }, + "specs": [ # Output only. The specs linked directly to this deployment. Note: a deployment could serve multiple specs (e.g., across different revisions of the same underlying gateway configuration). + "A String", + ], "updateTime": "A String", # Output only. The time at which the deployment was last updated. }, "version": { # Represents a version of the API resource in API hub. This is also referred to as the API version. # Optional. The version. @@ -2113,6 +2133,9 @@

Method Details

}, }, "createTime": "A String", # Output only. The time at which the operation was created. + "deployments": [ # Optional. The deployments linked directly to this API operation. For operations parsed from a spec, `UpdateApiOperation` returns `FAILED_PRECONDITION`; link the parent spec to the deployment via `Spec.deployments` instead. Format is `projects/{project}/locations/{location}/deployments/{deployment}` + "A String", + ], "details": { # The operation details parsed from the spec. # Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided. "deprecated": True or False, # Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec. "description": "A String", # Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used. @@ -2169,6 +2192,9 @@

Method Details

"updateTime": "A String", # Output only. The time at which the operation was last updated. }, "deployment": { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. # Optional. The deployment. + "apiOperations": [ # Output only. The API operations linked directly to this deployment. + "A String", + ], "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). "A String", ], @@ -2339,6 +2365,7 @@

Method Details

}, ], "sourceProject": "A String", # Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. + "sourceRevision": "A String", # Optional. A revision identifier for the underlying gateway configuration that this deployment serves. For Apigee gateway variants, this is typically the proxy revision number populated automatically when the deployment is discovered. "sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -2367,6 +2394,9 @@

Method Details

], }, }, + "specs": [ # Output only. The specs linked directly to this deployment. Note: a deployment could serve multiple specs (e.g., across different revisions of the same underlying gateway configuration). + "A String", + ], "updateTime": "A String", # Output only. The time at which the deployment was last updated. }, "version": { # Represents a version of the API resource in API hub. This is also referred to as the API version. # Optional. The version. @@ -2895,6 +2925,9 @@

Method Details

"updateTime": "A String", # Output only. The time at which the definition was last updated. }, "deployment": { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. # This represents Deployment resource in search results. Only name, display_name, description, deployment_type and api_versions fields are populated in search results. + "apiOperations": [ # Output only. The API operations linked directly to this deployment. + "A String", + ], "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). "A String", ], @@ -3065,6 +3098,7 @@

Method Details

}, ], "sourceProject": "A String", # Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. + "sourceRevision": "A String", # Optional. A revision identifier for the underlying gateway configuration that this deployment serves. For Apigee gateway variants, this is typically the proxy revision number populated automatically when the deployment is discovered. "sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -3093,6 +3127,9 @@

Method Details

], }, }, + "specs": [ # Output only. The specs linked directly to this deployment. Note: a deployment could serve multiple specs (e.g., across different revisions of the same underlying gateway configuration). + "A String", + ], "updateTime": "A String", # Output only. The time at which the deployment was last updated. }, "operation": { # Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API. # This represents ApiOperation resource in search results. Only name, description, spec and details fields are populated in search results. @@ -3127,6 +3164,9 @@

Method Details

}, }, "createTime": "A String", # Output only. The time at which the operation was created. + "deployments": [ # Optional. The deployments linked directly to this API operation. For operations parsed from a spec, `UpdateApiOperation` returns `FAILED_PRECONDITION`; link the parent spec to the deployment via `Spec.deployments` instead. Format is `projects/{project}/locations/{location}/deployments/{deployment}` + "A String", + ], "details": { # The operation details parsed from the spec. # Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided. "deprecated": True or False, # Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec. "description": "A String", # Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used. @@ -3232,6 +3272,9 @@

Method Details

"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. }, "createTime": "A String", # Output only. The time at which the spec was created. + "deployments": [ # Optional. The deployments linked directly to this spec. Format is `projects/{project}/locations/{location}/deployments/{deployment}` + "A String", + ], "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec. "description": "A String", # Output only. The description of the spec. "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method. diff --git a/googleapiclient/discovery_cache/documents/apihub.v1.json b/googleapiclient/discovery_cache/documents/apihub.v1.json index d04ae26422..16a2ccba8f 100644 --- a/googleapiclient/discovery_cache/documents/apihub.v1.json +++ b/googleapiclient/discovery_cache/documents/apihub.v1.json @@ -3450,7 +3450,7 @@ } } }, -"revision": "20260831", +"revision": "20260907", "rootUrl": "https://apihub.googleapis.com/", "schemas": { "Empty": { @@ -3955,6 +3955,13 @@ "readOnly": true, "type": "string" }, +"deployments": { +"description": "Optional. The deployments linked directly to this API operation. For operations parsed from a spec, `UpdateApiOperation` returns `FAILED_PRECONDITION`; link the parent spec to the deployment via `Spec.deployments` instead. Format is `projects/{project}/locations/{location}/deployments/{deployment}`", +"items": { +"type": "string" +}, +"type": "array" +}, "details": { "$ref": "GoogleCloudApihubV1OperationDetails", "description": "Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided." @@ -4808,6 +4815,14 @@ "description": "Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API.", "id": "GoogleCloudApihubV1Deployment", "properties": { +"apiOperations": { +"description": "Output only. The API operations linked directly to this deployment.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "apiVersions": { "description": "Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).", "items": { @@ -4888,10 +4903,22 @@ "description": "Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier.", "type": "string" }, +"sourceRevision": { +"description": "Optional. A revision identifier for the underlying gateway configuration that this deployment serves. For Apigee gateway variants, this is typically the proxy revision number populated automatically when the deployment is discovered.", +"type": "string" +}, "sourceUri": { "$ref": "GoogleCloudApihubV1AttributeValues", "description": "Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory." }, +"specs": { +"description": "Output only. The specs linked directly to this deployment. Note: a deployment could serve multiple specs (e.g., across different revisions of the same underlying gateway configuration).", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "updateTime": { "description": "Output only. The time at which the deployment was last updated.", "format": "google-datetime", @@ -7125,6 +7152,13 @@ "readOnly": true, "type": "string" }, +"deployments": { +"description": "Optional. The deployments linked directly to this spec. Format is `projects/{project}/locations/{location}/deployments/{deployment}`", +"items": { +"type": "string" +}, +"type": "array" +}, "details": { "$ref": "GoogleCloudApihubV1SpecDetails", "description": "Output only. Details parsed from the spec.", @@ -7222,6 +7256,13 @@ "description": "The metadata associated with a spec of the API version.", "id": "GoogleCloudApihubV1SpecMetadata", "properties": { +"deploymentResourceUris": { +"description": "Optional. The gateway-side URIs of deployments that serve this spec. If provided, the API Hub service creates links between this spec and the deployments identified by these URIs. URIs that don't match any known deployment are ignored; a subsequent ingestion cycle that includes the missing deployment will re-establish the link. The maximum number of URIs allowed is 100.", +"items": { +"type": "string" +}, +"type": "array" +}, "originalCreateTime": { "description": "Optional. Timestamp indicating when the spec was created at the source.", "format": "google-datetime", From 94a2db13f17c2280241ed03f82632cd008117474 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:28 +0000 Subject: [PATCH 07/30] fix(biglake): update the api #### biglake:v1 The following keys were changed: - endpoints (Total Keys: 1) --- .../discovery_cache/documents/biglake.v1.json | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/biglake.v1.json b/googleapiclient/discovery_cache/documents/biglake.v1.json index c1f744fae2..db1cdad9ce 100644 --- a/googleapiclient/discovery_cache/documents/biglake.v1.json +++ b/googleapiclient/discovery_cache/documents/biglake.v1.json @@ -21,6 +21,16 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://biglake.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://biglake.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://biglake.us-central1.rep.googleapis.com/", "location": "us-central1" } @@ -909,7 +919,7 @@ } } }, -"revision": "20260724", +"revision": "20260905", "rootUrl": "https://biglake.googleapis.com/", "schemas": { "AuditConfig": { From 211b1dd30373554fcf509e2fef595f1962123987 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:28 +0000 Subject: [PATCH 08/30] feat(chromemanagement): update the api #### chromemanagement:v1 The following keys were added: - resources.customers.resources.reports.methods.findSaasUsage (Total Keys: 64) - schemas.GoogleChromeManagementV1FindSaasUsageBrowsersResponse (Total Keys: 7) - schemas.GoogleChromeManagementV1FindSaasUsageProfilesResponse (Total Keys: 7) - schemas.GoogleChromeManagementV1FindSaasUsageReportsResponse (Total Keys: 7) - schemas.GoogleChromeManagementV1SaasUsageBrowser (Total Keys: 18) - schemas.GoogleChromeManagementV1SaasUsageProfileReport (Total Keys: 18) - schemas.GoogleChromeManagementV1SaasUsageReport (Total Keys: 45) --- ...chromemanagement_v1.customers.reports.html | 181 +++++++ .../documents/chromemanagement.v1.json | 454 +++++++++++++++++- 2 files changed, 634 insertions(+), 1 deletion(-) diff --git a/docs/dyn/chromemanagement_v1.customers.reports.html b/docs/dyn/chromemanagement_v1.customers.reports.html index 8cde7cac7f..38d63b3b87 100644 --- a/docs/dyn/chromemanagement_v1.customers.reports.html +++ b/docs/dyn/chromemanagement_v1.customers.reports.html @@ -149,6 +149,24 @@

Instance Methods

findInstalledAppProfiles_next(previous_request, previous_response)

Retrieves the next page of results.

+

+ findSaasUsage(customer, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Find SaaS usage reports of a customer based on the given search and sorting criteria.

+

+ findSaasUsageBrowsers(customer, app=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Find SaaS usage reports of a customer grouped by browsers based on the given search and sorting criteria.

+

+ findSaasUsageBrowsers_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ findSaasUsageProfiles(customer, app=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Find SaaS usage reports of a customer grouped by profiles based on the given search and sorting criteria.

+

+ findSaasUsageProfiles_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ findSaasUsage_next(previous_request, previous_response)

+

Retrieves the next page of results.

Method Details

close() @@ -812,4 +830,167 @@

Method Details

+
+ findSaasUsage(customer, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Find SaaS usage reports of a customer based on the given search and sorting criteria.
+
+Args:
+  customer: string, Required. Obfuscated customer ID prefixed with "customers/C" or "customers/my_customer". (required)
+  filter: string, Optional. The filter expression to narrow down the SaaS reports to return. Supported operators are: =, !=, <, <=, >, >=, :. Logical operators AND, OR, and NOT are supported. Supported fields: * app * org_unit_id * first_navigation_time * last_navigation_time * category * organization * founded_year * headquarters * primary_domain * domains * encryption_protocols * visits_count * distinct_users_count * distinct_browsers_count * content_transfer_count Example: `(first_navigation_time < "2026-01-31T00:00:00Z" AND last_navigation_time > "2026-01-01T00:00:00Z") AND visits_count > 100`
+  orderBy: string, Optional. The order by expression to sort the SaaS reports. Supported fields: * app * category * organization * founded_year * headquarters * primary_domain * visits_count * distinct_users_count * distinct_browsers_count * content_transfer_count Default order is ascending. To specify descending order for a field, append " desc". Example: `visits_count desc`
+  pageSize: integer, Optional. The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 100 reports will be returned. The maximum value is 200; values above 200 will be coerced to 200.
+  pageToken: string, Optional. A page token, received from a previous `FindSaasUsageReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FindSaasUsageReports` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response to `FindSaasUsage` method.
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "saasReports": [ # The list of SaaS usage reports.
+    { # Represents a single SaaS report entry.
+      "app": "A String", # Output only. The name of the application.
+      "category": "A String", # Output only. The category of the application.
+      "contentTransferDetails": { # Provides information about content transfer events, if available. # Output only. Provides information about content transfer events, if available.
+        "contentTransferCount": "A String", # Output only. Total number of content transfers associated with the application.
+      },
+      "distinctBrowsersCount": "A String", # Output only. Number of distinct browsers that visited the application.
+      "distinctUsersCount": "A String", # Output only. Number of distinct users who visited the application.
+      "domains": [ # Output only. A list of domains and subdomains associated with the application.
+        "A String",
+      ],
+      "encryptionProtocols": [ # Output only. A list of encryption protocols used to access the application.
+        "A String",
+      ],
+      "firstNavigationTime": "A String", # Output only. The timestamp when the application was first navigated to.
+      "foundedYear": 42, # Output only. The year the organization was founded.
+      "headquarters": "A String", # Output only. The headquarters location of the organization.
+      "lastNavigationTime": "A String", # Output only. The timestamp when the application was last navigated to.
+      "orgUnitId": "A String", # Output only. The ID of the organizational unit.
+      "organization": "A String", # Output only. The organization that develops the application.
+      "primaryDomain": "A String", # Output only. The primary domain of the application.
+      "visitsCount": "A String", # Output only. Total number of visits to the application.
+    },
+  ],
+  "totalSize": "A String", # Total number of SaaS usage reports that match the request.
+}
+
+ +
+ findSaasUsageBrowsers(customer, app=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Find SaaS usage reports of a customer grouped by browsers based on the given search and sorting criteria.
+
+Args:
+  customer: string, Required. Obfuscated customer ID prefixed with "customers/C" or "customers/my_customer". (required)
+  app: string, Required. The name of the SaaS application (e.g., `ChatGPT`, `Gemini`).
+  filter: string, Optional. The filter expression to narrow down the SaaS browser reports to return. Supported operators are: =, !=, <, <=, >, >=, :. Logical operators AND, OR, and NOT are supported. Supported fields: * machine * os_platform * first_navigation_time * last_navigation_time * org_unit_id
+  orderBy: string, Optional. The order by expression to sort the SaaS browser reports. Supported fields: * machine * os_platform * first_navigation_time * last_navigation_time Default order is ascending. To specify descending order for a field, append " desc".
+  pageSize: integer, Optional. The maximum number of browsers to return. The service may return fewer than this value. If unspecified, at most 100 browsers will be returned. The maximum value is 200; values above 200 will be coerced to 200.
+  pageToken: string, Optional. A page token, received from a previous `FindSaasUsageBrowsers` 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 `FindSaasUsageBrowsers` method.
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page.
+  "saasUsageBrowsers": [ # The list of SaaS usage browser reports.
+    { # Details of a SaaS usage browser.
+      "devicePermanentId": "A String", # Output only. The device permanent ID.
+      "firstNavigationTime": "A String", # Output only. The timestamp when the application was first navigated to by this browser.
+      "lastNavigationTime": "A String", # Output only. The timestamp when the application was last navigated to by this browser.
+      "machine": "A String", # Output only. The machine name.
+      "orgUnitId": "A String", # Output only. The ID of the organizational unit.
+      "osPlatform": "A String", # Output only. The OS platform.
+      "osVersion": "A String", # Output only. The OS version.
+    },
+  ],
+  "totalSize": "A String", # Total number of SaaS usage browser reports that match the request.
+}
+
+ +
+ findSaasUsageBrowsers_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ findSaasUsageProfiles(customer, app=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Find SaaS usage reports of a customer grouped by profiles based on the given search and sorting criteria.
+
+Args:
+  customer: string, Required. Obfuscated customer ID prefixed with "customers/C" or "customers/my_customer". (required)
+  app: string, Required. The name of the SaaS application (e.g., `ChatGPT`, `Gemini`).
+  filter: string, Optional. The filter expression to narrow down the SaaS profile reports to return. Supported operators are: =, !=, <, <=, >, >=, :. Logical operators AND, OR, and NOT are supported. Supported fields: * email * org_unit_id * os_platform * first_navigation_time * last_navigation_time
+  orderBy: string, Optional. The order by expression to sort the SaaS profile reports. Supported fields: * email * os_platform * first_navigation_time * last_navigation_time Default order is ascending. To specify descending order for a field, append " desc".
+  pageSize: integer, Optional. The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 100 reports will be returned. The maximum value is 200; values above 200 will be coerced to 200.
+  pageToken: string, Optional. A page token, received from a previous `FindSaasUsageProfiles` 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 `FindSaasUsageProfiles` method.
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "profileReports": [ # The list of SaaS usage profile reports.
+    { # Represents a single SaaS report entry grouped by profile.
+      "email": "A String", # Output only. The email of the user.
+      "firstNavigationTime": "A String", # Output only. The timestamp when the application was first navigated to by this profile.
+      "lastNavigationTime": "A String", # Output only. The timestamp when the application was last navigated to by this profile.
+      "orgUnitId": "A String", # Output only. The ID of the organizational unit.
+      "osPlatform": "A String", # Output only. The OS platform.
+      "osVersion": "A String", # Output only. The OS version.
+      "profilePermanentId": "A String", # Output only. The permanent ID of the profile.
+    },
+  ],
+  "totalSize": "A String", # Total number of SaaS usage profile reports that match the request.
+}
+
+ +
+ findSaasUsageProfiles_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ findSaasUsage_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index a4017f5647..f04b43b1ec 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -1965,6 +1965,154 @@ "scopes": [ "https://www.googleapis.com/auth/chrome.management.reports.readonly" ] +}, +"findSaasUsage": { +"description": "Find SaaS usage reports of a customer based on the given search and sorting criteria.", +"flatPath": "v1/customers/{customersId}/reports:findSaasUsage", +"httpMethod": "GET", +"id": "chromemanagement.customers.reports.findSaasUsage", +"parameterOrder": [ +"customer" +], +"parameters": { +"customer": { +"description": "Required. Obfuscated customer ID prefixed with \"customers/C\" or \"customers/my_customer\".", +"location": "path", +"pattern": "^customers/[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Optional. The filter expression to narrow down the SaaS reports to return. Supported operators are: =, !=, <, <=, >, >=, :. Logical operators AND, OR, and NOT are supported. Supported fields: * app * org_unit_id * first_navigation_time * last_navigation_time * category * organization * founded_year * headquarters * primary_domain * domains * encryption_protocols * visits_count * distinct_users_count * distinct_browsers_count * content_transfer_count Example: `(first_navigation_time < \"2026-01-31T00:00:00Z\" AND last_navigation_time > \"2026-01-01T00:00:00Z\") AND visits_count > 100`", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. The order by expression to sort the SaaS reports. Supported fields: * app * category * organization * founded_year * headquarters * primary_domain * visits_count * distinct_users_count * distinct_browsers_count * content_transfer_count Default order is ascending. To specify descending order for a field, append \" desc\". Example: `visits_count desc`", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 100 reports will be returned. The maximum value is 200; values above 200 will be coerced to 200.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `FindSaasUsageReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FindSaasUsageReports` must match the call that provided the page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+customer}/reports:findSaasUsage", +"response": { +"$ref": "GoogleChromeManagementV1FindSaasUsageReportsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/chrome.management.reports.readonly" +] +}, +"findSaasUsageBrowsers": { +"description": "Find SaaS usage reports of a customer grouped by browsers based on the given search and sorting criteria.", +"flatPath": "v1/customers/{customersId}/reports:findSaasUsageBrowsers", +"httpMethod": "GET", +"id": "chromemanagement.customers.reports.findSaasUsageBrowsers", +"parameterOrder": [ +"customer" +], +"parameters": { +"app": { +"description": "Required. The name of the SaaS application (e.g., `ChatGPT`, `Gemini`).", +"location": "query", +"type": "string" +}, +"customer": { +"description": "Required. Obfuscated customer ID prefixed with \"customers/C\" or \"customers/my_customer\".", +"location": "path", +"pattern": "^customers/[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Optional. The filter expression to narrow down the SaaS browser reports to return. Supported operators are: =, !=, <, <=, >, >=, :. Logical operators AND, OR, and NOT are supported. Supported fields: * machine * os_platform * first_navigation_time * last_navigation_time * org_unit_id", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. The order by expression to sort the SaaS browser reports. Supported fields: * machine * os_platform * first_navigation_time * last_navigation_time Default order is ascending. To specify descending order for a field, append \" desc\".", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of browsers to return. The service may return fewer than this value. If unspecified, at most 100 browsers will be returned. The maximum value is 200; values above 200 will be coerced to 200.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `FindSaasUsageBrowsers` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+customer}/reports:findSaasUsageBrowsers", +"response": { +"$ref": "GoogleChromeManagementV1FindSaasUsageBrowsersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/chrome.management.reports.readonly" +] +}, +"findSaasUsageProfiles": { +"description": "Find SaaS usage reports of a customer grouped by profiles based on the given search and sorting criteria.", +"flatPath": "v1/customers/{customersId}/reports:findSaasUsageProfiles", +"httpMethod": "GET", +"id": "chromemanagement.customers.reports.findSaasUsageProfiles", +"parameterOrder": [ +"customer" +], +"parameters": { +"app": { +"description": "Required. The name of the SaaS application (e.g., `ChatGPT`, `Gemini`).", +"location": "query", +"type": "string" +}, +"customer": { +"description": "Required. Obfuscated customer ID prefixed with \"customers/C\" or \"customers/my_customer\".", +"location": "path", +"pattern": "^customers/[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Optional. The filter expression to narrow down the SaaS profile reports to return. Supported operators are: =, !=, <, <=, >, >=, :. Logical operators AND, OR, and NOT are supported. Supported fields: * email * org_unit_id * os_platform * first_navigation_time * last_navigation_time", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. The order by expression to sort the SaaS profile reports. Supported fields: * email * os_platform * first_navigation_time * last_navigation_time Default order is ascending. To specify descending order for a field, append \" desc\".", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 100 reports will be returned. The maximum value is 200; values above 200 will be coerced to 200.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `FindSaasUsageProfiles` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+customer}/reports:findSaasUsageProfiles", +"response": { +"$ref": "GoogleChromeManagementV1FindSaasUsageProfilesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/chrome.management.reports.readonly" +] } } }, @@ -2409,7 +2557,7 @@ } } }, -"revision": "20260715", +"revision": "20260907", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -4031,6 +4179,75 @@ false }, "type": "object" }, +"GoogleChromeManagementV1FindSaasUsageBrowsersResponse": { +"description": "Response to `FindSaasUsageBrowsers` method.", +"id": "GoogleChromeManagementV1FindSaasUsageBrowsersResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page.", +"type": "string" +}, +"saasUsageBrowsers": { +"description": "The list of SaaS usage browser reports.", +"items": { +"$ref": "GoogleChromeManagementV1SaasUsageBrowser" +}, +"type": "array" +}, +"totalSize": { +"description": "Total number of SaaS usage browser reports that match the request.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleChromeManagementV1FindSaasUsageProfilesResponse": { +"description": "Response to `FindSaasUsageProfiles` method.", +"id": "GoogleChromeManagementV1FindSaasUsageProfilesResponse", +"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" +}, +"profileReports": { +"description": "The list of SaaS usage profile reports.", +"items": { +"$ref": "GoogleChromeManagementV1SaasUsageProfileReport" +}, +"type": "array" +}, +"totalSize": { +"description": "Total number of SaaS usage profile reports that match the request.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleChromeManagementV1FindSaasUsageReportsResponse": { +"description": "Response to `FindSaasUsage` method.", +"id": "GoogleChromeManagementV1FindSaasUsageReportsResponse", +"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" +}, +"saasReports": { +"description": "The list of SaaS usage reports.", +"items": { +"$ref": "GoogleChromeManagementV1SaasUsageReport" +}, +"type": "array" +}, +"totalSize": { +"description": "Total number of SaaS usage reports that match the request.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "GoogleChromeManagementV1GraphicsAdapterInfo": { "description": "Information of a graphics adapter (GPU).", "id": "GoogleChromeManagementV1GraphicsAdapterInfo", @@ -5042,6 +5259,241 @@ false }, "type": "object" }, +"GoogleChromeManagementV1SaasUsageBrowser": { +"description": "Details of a SaaS usage browser.", +"id": "GoogleChromeManagementV1SaasUsageBrowser", +"properties": { +"devicePermanentId": { +"description": "Output only. The device permanent ID.", +"readOnly": true, +"type": "string" +}, +"firstNavigationTime": { +"description": "Output only. The timestamp when the application was first navigated to by this browser.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"lastNavigationTime": { +"description": "Output only. The timestamp when the application was last navigated to by this browser.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"machine": { +"description": "Output only. The machine name.", +"readOnly": true, +"type": "string" +}, +"orgUnitId": { +"description": "Output only. The ID of the organizational unit.", +"readOnly": true, +"type": "string" +}, +"osPlatform": { +"description": "Output only. The OS platform.", +"enum": [ +"DEVICE_SYSTEM_UNSPECIFIED", +"SYSTEM_OTHER", +"SYSTEM_ANDROID", +"SYSTEM_IOS", +"SYSTEM_CROS", +"SYSTEM_WINDOWS", +"SYSTEM_MAC", +"SYSTEM_LINUX" +], +"enumDescriptions": [ +"No operating system specified.", +"Other operating system.", +"Android operating system.", +"Apple iOS operating system.", +"ChromeOS operating system.", +"Microsoft Windows operating system.", +"Apple macOS operating system.", +"Linux operating system." +], +"readOnly": true, +"type": "string" +}, +"osVersion": { +"description": "Output only. The OS version.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleChromeManagementV1SaasUsageProfileReport": { +"description": "Represents a single SaaS report entry grouped by profile.", +"id": "GoogleChromeManagementV1SaasUsageProfileReport", +"properties": { +"email": { +"description": "Output only. The email of the user.", +"readOnly": true, +"type": "string" +}, +"firstNavigationTime": { +"description": "Output only. The timestamp when the application was first navigated to by this profile.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"lastNavigationTime": { +"description": "Output only. The timestamp when the application was last navigated to by this profile.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"orgUnitId": { +"description": "Output only. The ID of the organizational unit.", +"readOnly": true, +"type": "string" +}, +"osPlatform": { +"description": "Output only. The OS platform.", +"enum": [ +"DEVICE_SYSTEM_UNSPECIFIED", +"SYSTEM_OTHER", +"SYSTEM_ANDROID", +"SYSTEM_IOS", +"SYSTEM_CROS", +"SYSTEM_WINDOWS", +"SYSTEM_MAC", +"SYSTEM_LINUX" +], +"enumDescriptions": [ +"No operating system specified.", +"Other operating system.", +"Android operating system.", +"Apple iOS operating system.", +"ChromeOS operating system.", +"Microsoft Windows operating system.", +"Apple macOS operating system.", +"Linux operating system." +], +"readOnly": true, +"type": "string" +}, +"osVersion": { +"description": "Output only. The OS version.", +"readOnly": true, +"type": "string" +}, +"profilePermanentId": { +"description": "Output only. The permanent ID of the profile.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleChromeManagementV1SaasUsageReport": { +"description": "Represents a single SaaS report entry.", +"id": "GoogleChromeManagementV1SaasUsageReport", +"properties": { +"app": { +"description": "Output only. The name of the application.", +"readOnly": true, +"type": "string" +}, +"category": { +"description": "Output only. The category of the application.", +"readOnly": true, +"type": "string" +}, +"contentTransferDetails": { +"$ref": "GoogleChromeManagementV1SaasUsageReportContentTransferDetails", +"description": "Output only. Provides information about content transfer events, if available.", +"readOnly": true +}, +"distinctBrowsersCount": { +"description": "Output only. Number of distinct browsers that visited the application.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"distinctUsersCount": { +"description": "Output only. Number of distinct users who visited the application.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"domains": { +"description": "Output only. A list of domains and subdomains associated with the application.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"encryptionProtocols": { +"description": "Output only. A list of encryption protocols used to access the application.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"firstNavigationTime": { +"description": "Output only. The timestamp when the application was first navigated to.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"foundedYear": { +"description": "Output only. The year the organization was founded.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"headquarters": { +"description": "Output only. The headquarters location of the organization.", +"readOnly": true, +"type": "string" +}, +"lastNavigationTime": { +"description": "Output only. The timestamp when the application was last navigated to.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"orgUnitId": { +"description": "Output only. The ID of the organizational unit.", +"readOnly": true, +"type": "string" +}, +"organization": { +"description": "Output only. The organization that develops the application.", +"readOnly": true, +"type": "string" +}, +"primaryDomain": { +"description": "Output only. The primary domain of the application.", +"readOnly": true, +"type": "string" +}, +"visitsCount": { +"description": "Output only. Total number of visits to the application.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleChromeManagementV1SaasUsageReportContentTransferDetails": { +"description": "Provides information about content transfer events, if available.", +"id": "GoogleChromeManagementV1SaasUsageReportContentTransferDetails", +"properties": { +"contentTransferCount": { +"description": "Output only. Total number of content transfers associated with the application.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleChromeManagementV1StorageInfo": { "description": "Status data for storage. * This field is telemetry information and this will change over time as the device is utilized. * Data for this field is controlled via policy: [ReportDeviceStorageStatus](https://chromeenterprise.google/policies/#ReportDeviceStorageStatus) * Data Collection Frequency: Only at Upload * Default Data Reporting Frequency: 3 hours - Policy Controlled: Yes * Cache: If the device is offline, the collected data is stored locally, and will be reported when the device is next online: No * Reported for affiliated users only: N/A * Granular permission needed: TELEMETRY_API_STORAGE_INFO", "id": "GoogleChromeManagementV1StorageInfo", From bd491dcafacde4db1a8cbbfa426b247ff1be63f5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:28 +0000 Subject: [PATCH 09/30] feat(cloudbuild): update the api #### cloudbuild:v2 The following keys were deleted: - schemas.PipelineRun (Total Keys: 61) The following keys were added: - schemas.GoogleDevtoolsCloudbuildV2PipelineRun (Total Keys: 61) --- .../documents/cloudbuild.v2.json | 358 +++++++++--------- 1 file changed, 179 insertions(+), 179 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json index a7661eb776..ffd911ad11 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json @@ -1097,7 +1097,7 @@ } } }, -"revision": "20260511", +"revision": "20260904", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { @@ -1745,6 +1745,184 @@ }, "type": "object" }, +"GoogleDevtoolsCloudbuildV2PipelineRun": { +"description": "Message describing PipelineRun object", +"id": "GoogleDevtoolsCloudbuildV2PipelineRun", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "User annotations. See https://google.aip.dev/128#annotations", +"type": "object" +}, +"childReferences": { +"description": "Output only. List of TaskRun and Run names and PipelineTask names for children of this PipelineRun.", +"items": { +"$ref": "ChildStatusReference" +}, +"readOnly": true, +"type": "array" +}, +"completionTime": { +"description": "Output only. Time the pipeline completed.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"conditions": { +"description": "Output only. Kubernetes Conditions convention for PipelineRun status and error.", +"items": { +"$ref": "GoogleDevtoolsCloudbuildV2Condition" +}, +"readOnly": true, +"type": "array" +}, +"createTime": { +"description": "Output only. Time at which the request to create the `PipelineRun` was received.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"etag": { +"description": "Needed for declarative-friendly resources.", +"type": "string" +}, +"finallyStartTime": { +"description": "Output only. FinallyStartTime is when all non-finally tasks have been completed and only finally tasks are being executed. +optional", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"gcbParams": { +"additionalProperties": { +"type": "string" +}, +"description": "Output only. GCB default params.", +"readOnly": true, +"type": "object" +}, +"name": { +"description": "Output only. The `PipelineRun` name with format `projects/{project}/locations/{location}/pipelineRuns/{pipeline_run}`", +"readOnly": true, +"type": "string" +}, +"params": { +"description": "Params is a list of parameter names and values.", +"items": { +"$ref": "Param" +}, +"type": "array" +}, +"pipelineRef": { +"$ref": "PipelineRef", +"description": "PipelineRef refer to a specific instance of a Pipeline." +}, +"pipelineRunStatus": { +"description": "Pipelinerun status the user can provide. Used for cancellation.", +"enum": [ +"PIPELINE_RUN_STATUS_UNSPECIFIED", +"PIPELINE_RUN_CANCELLED" +], +"enumDescriptions": [ +"Default enum type; should not be used.", +"Cancelled status." +], +"type": "string" +}, +"pipelineSpec": { +"$ref": "PipelineSpec", +"description": "PipelineSpec defines the desired state of Pipeline." +}, +"pipelineSpecYaml": { +"description": "Output only. Inline pipelineSpec yaml string, used by workflow run requests.", +"readOnly": true, +"type": "string" +}, +"provenance": { +"$ref": "Provenance", +"description": "Optional. Provenance configuration." +}, +"record": { +"description": "Output only. The `Record` of this `PipelineRun`. Format: `projects/{project}/locations/{location}/results/{result_id}/records/{record_id}`", +"readOnly": true, +"type": "string" +}, +"resolvedPipelineSpec": { +"$ref": "PipelineSpec", +"description": "Output only. The exact PipelineSpec used to instantiate the run.", +"readOnly": true +}, +"results": { +"description": "Optional. Output only. List of results written out by the pipeline's containers", +"items": { +"$ref": "PipelineRunResult" +}, +"readOnly": true, +"type": "array" +}, +"security": { +"$ref": "Security", +"description": "Optional. Security configuration." +}, +"serviceAccount": { +"deprecated": true, +"description": "Service account used in the Pipeline. Deprecated; please use security.service_account instead.", +"type": "string" +}, +"skippedTasks": { +"description": "Output only. List of tasks that were skipped due to when expressions evaluating to false.", +"items": { +"$ref": "SkippedTask" +}, +"readOnly": true, +"type": "array" +}, +"startTime": { +"description": "Output only. Time the pipeline is actually started.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"timeouts": { +"$ref": "TimeoutFields", +"description": "Time after which the Pipeline times out. Currently three keys are accepted in the map pipeline, tasks and finally with Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally" +}, +"uid": { +"description": "Output only. A unique identifier for the `PipelineRun`.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Time at which the request to update the `PipelineRun` was received.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"worker": { +"$ref": "Worker", +"description": "Optional. Worker configuration." +}, +"workerPool": { +"description": "Output only. The WorkerPool used to run this PipelineRun.", +"readOnly": true, +"type": "string" +}, +"workflow": { +"description": "Output only. The Workflow used to create this PipelineRun.", +"readOnly": true, +"type": "string" +}, +"workspaces": { +"description": "Workspaces is a list of WorkspaceBindings from volumes to workspaces.", +"items": { +"$ref": "WorkspaceBinding" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig": { "description": "ServiceDirectoryConfig represents Service Directory configuration for a connection.", "id": "GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig", @@ -2184,184 +2362,6 @@ }, "type": "object" }, -"PipelineRun": { -"description": "Message describing PipelineRun object", -"id": "PipelineRun", -"properties": { -"annotations": { -"additionalProperties": { -"type": "string" -}, -"description": "User annotations. See https://google.aip.dev/128#annotations", -"type": "object" -}, -"childReferences": { -"description": "Output only. List of TaskRun and Run names and PipelineTask names for children of this PipelineRun.", -"items": { -"$ref": "ChildStatusReference" -}, -"readOnly": true, -"type": "array" -}, -"completionTime": { -"description": "Output only. Time the pipeline completed.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"conditions": { -"description": "Output only. Kubernetes Conditions convention for PipelineRun status and error.", -"items": { -"$ref": "GoogleDevtoolsCloudbuildV2Condition" -}, -"readOnly": true, -"type": "array" -}, -"createTime": { -"description": "Output only. Time at which the request to create the `PipelineRun` was received.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"etag": { -"description": "Needed for declarative-friendly resources.", -"type": "string" -}, -"finallyStartTime": { -"description": "Output only. FinallyStartTime is when all non-finally tasks have been completed and only finally tasks are being executed. +optional", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"gcbParams": { -"additionalProperties": { -"type": "string" -}, -"description": "Output only. GCB default params.", -"readOnly": true, -"type": "object" -}, -"name": { -"description": "Output only. The `PipelineRun` name with format `projects/{project}/locations/{location}/pipelineRuns/{pipeline_run}`", -"readOnly": true, -"type": "string" -}, -"params": { -"description": "Params is a list of parameter names and values.", -"items": { -"$ref": "Param" -}, -"type": "array" -}, -"pipelineRef": { -"$ref": "PipelineRef", -"description": "PipelineRef refer to a specific instance of a Pipeline." -}, -"pipelineRunStatus": { -"description": "Pipelinerun status the user can provide. Used for cancellation.", -"enum": [ -"PIPELINE_RUN_STATUS_UNSPECIFIED", -"PIPELINE_RUN_CANCELLED" -], -"enumDescriptions": [ -"Default enum type; should not be used.", -"Cancelled status." -], -"type": "string" -}, -"pipelineSpec": { -"$ref": "PipelineSpec", -"description": "PipelineSpec defines the desired state of Pipeline." -}, -"pipelineSpecYaml": { -"description": "Output only. Inline pipelineSpec yaml string, used by workflow run requests.", -"readOnly": true, -"type": "string" -}, -"provenance": { -"$ref": "Provenance", -"description": "Optional. Provenance configuration." -}, -"record": { -"description": "Output only. The `Record` of this `PipelineRun`. Format: `projects/{project}/locations/{location}/results/{result_id}/records/{record_id}`", -"readOnly": true, -"type": "string" -}, -"resolvedPipelineSpec": { -"$ref": "PipelineSpec", -"description": "Output only. The exact PipelineSpec used to instantiate the run.", -"readOnly": true -}, -"results": { -"description": "Optional. Output only. List of results written out by the pipeline's containers", -"items": { -"$ref": "PipelineRunResult" -}, -"readOnly": true, -"type": "array" -}, -"security": { -"$ref": "Security", -"description": "Optional. Security configuration." -}, -"serviceAccount": { -"deprecated": true, -"description": "Service account used in the Pipeline. Deprecated; please use security.service_account instead.", -"type": "string" -}, -"skippedTasks": { -"description": "Output only. List of tasks that were skipped due to when expressions evaluating to false.", -"items": { -"$ref": "SkippedTask" -}, -"readOnly": true, -"type": "array" -}, -"startTime": { -"description": "Output only. Time the pipeline is actually started.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"timeouts": { -"$ref": "TimeoutFields", -"description": "Time after which the Pipeline times out. Currently three keys are accepted in the map pipeline, tasks and finally with Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally" -}, -"uid": { -"description": "Output only. A unique identifier for the `PipelineRun`.", -"readOnly": true, -"type": "string" -}, -"updateTime": { -"description": "Output only. Time at which the request to update the `PipelineRun` was received.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"worker": { -"$ref": "Worker", -"description": "Optional. Worker configuration." -}, -"workerPool": { -"description": "Output only. The WorkerPool used to run this PipelineRun.", -"readOnly": true, -"type": "string" -}, -"workflow": { -"description": "Output only. The Workflow used to create this PipelineRun.", -"readOnly": true, -"type": "string" -}, -"workspaces": { -"description": "Workspaces is a list of WorkspaceBindings from volumes to workspaces.", -"items": { -"$ref": "WorkspaceBinding" -}, -"type": "array" -} -}, -"type": "object" -}, "PipelineRunResult": { "description": "PipelineRunResult used to describe the results of a pipeline", "id": "PipelineRunResult", From e746b9b6a324b59286d62c2a65886ec51673fea3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:28 +0000 Subject: [PATCH 10/30] feat(compute): update the api #### compute:v1 The following keys were added: - resources.advice.methods.capacity (Total Keys: 32) - resources.projectViews.methods.get (Total Keys: 15) - schemas.CapacityAdviceRequest (Total Keys: 36) - schemas.CapacityAdviceResponse (Total Keys: 23) - schemas.CapacityHistoryRequest (Total Keys: 16) - schemas.CapacityHistoryResponse (Total Keys: 18) - schemas.InstancePropertiesPatch.properties.exposeHostTopology.type (Total Keys: 1) - schemas.Interval (Total Keys: 6) - schemas.Money (Total Keys: 7) - schemas.ProjectView (Total Keys: 3) - schemas.Scheduling.properties.exposeHostTopology.type (Total Keys: 1) --- docs/dyn/compute_alpha.regionCommitments.html | 10 +- docs/dyn/compute_beta.regionCommitments.html | 10 +- docs/dyn/compute_v1.advice.html | 215 +++++++ docs/dyn/compute_v1.backendServices.html | 21 +- docs/dyn/compute_v1.html | 5 + .../dyn/compute_v1.instanceGroupManagers.html | 5 + docs/dyn/compute_v1.instanceTemplates.html | 8 + docs/dyn/compute_v1.instances.html | 14 + docs/dyn/compute_v1.machineImages.html | 12 + docs/dyn/compute_v1.projectViews.html | 206 +++++++ .../dyn/compute_v1.regionBackendServices.html | 18 +- docs/dyn/compute_v1.regionCommitments.html | 10 +- ...ompute_v1.regionInstanceGroupManagers.html | 4 + .../compute_v1.regionInstanceTemplates.html | 6 + docs/dyn/compute_v1.regionInstances.html | 2 + .../documents/compute.alpha.json | 10 +- .../documents/compute.beta.json | 10 +- .../discovery_cache/documents/compute.v1.json | 572 +++++++++++++++++- 18 files changed, 1103 insertions(+), 35 deletions(-) create mode 100644 docs/dyn/compute_v1.projectViews.html diff --git a/docs/dyn/compute_alpha.regionCommitments.html b/docs/dyn/compute_alpha.regionCommitments.html index e31aae9961..6a4b951b4f 100644 --- a/docs/dyn/compute_alpha.regionCommitments.html +++ b/docs/dyn/compute_alpha.regionCommitments.html @@ -686,7 +686,7 @@

Method Details

# resource types. # # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, - # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For + # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For # example, type MEMORY_OPTIMIZED specifies a commitment that # applies only to eligible resources of memory optimized M1 and M2 machine # series. Type GENERAL_PURPOSE specifies a commitment that @@ -1878,7 +1878,7 @@

Method Details

# resource types. # # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, - # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For + # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For # example, type MEMORY_OPTIMIZED specifies a commitment that # applies only to eligible resources of memory optimized M1 and M2 machine # series. Type GENERAL_PURPOSE specifies a commitment that @@ -2358,7 +2358,7 @@

Method Details

# resource types. # # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, - # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For + # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For # example, type MEMORY_OPTIMIZED specifies a commitment that # applies only to eligible resources of memory optimized M1 and M2 machine # series. Type GENERAL_PURPOSE specifies a commitment that @@ -3231,7 +3231,7 @@

Method Details

# resource types. # # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, - # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For + # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For # example, type MEMORY_OPTIMIZED specifies a commitment that # applies only to eligible resources of memory optimized M1 and M2 machine # series. Type GENERAL_PURPOSE specifies a commitment that @@ -3796,7 +3796,7 @@

Method Details

# resource types. # # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, - # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For + # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For # example, type MEMORY_OPTIMIZED specifies a commitment that # applies only to eligible resources of memory optimized M1 and M2 machine # series. Type GENERAL_PURPOSE specifies a commitment that diff --git a/docs/dyn/compute_beta.regionCommitments.html b/docs/dyn/compute_beta.regionCommitments.html index b3ee8909cb..bc8da939c5 100644 --- a/docs/dyn/compute_beta.regionCommitments.html +++ b/docs/dyn/compute_beta.regionCommitments.html @@ -616,7 +616,7 @@

Method Details

# resource types. # # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, - # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For + # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For # example, type MEMORY_OPTIMIZED specifies a commitment that # applies only to eligible resources of memory optimized M1 and M2 machine # series. Type GENERAL_PURPOSE specifies a commitment that @@ -1122,7 +1122,7 @@

Method Details

# resource types. # # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, - # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For + # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For # example, type MEMORY_OPTIMIZED specifies a commitment that # applies only to eligible resources of memory optimized M1 and M2 machine # series. Type GENERAL_PURPOSE specifies a commitment that @@ -1538,7 +1538,7 @@

Method Details

# resource types. # # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, - # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For + # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For # example, type MEMORY_OPTIMIZED specifies a commitment that # applies only to eligible resources of memory optimized M1 and M2 machine # series. Type GENERAL_PURPOSE specifies a commitment that @@ -2340,7 +2340,7 @@

Method Details

# resource types. # # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, - # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For + # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For # example, type MEMORY_OPTIMIZED specifies a commitment that # applies only to eligible resources of memory optimized M1 and M2 machine # series. Type GENERAL_PURPOSE specifies a commitment that @@ -2841,7 +2841,7 @@

Method Details

# resource types. # # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, - # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For + # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For # example, type MEMORY_OPTIMIZED specifies a commitment that # applies only to eligible resources of memory optimized M1 and M2 machine # series. Type GENERAL_PURPOSE specifies a commitment that diff --git a/docs/dyn/compute_v1.advice.html b/docs/dyn/compute_v1.advice.html index 7f86307da4..97d49e272b 100644 --- a/docs/dyn/compute_v1.advice.html +++ b/docs/dyn/compute_v1.advice.html @@ -77,6 +77,12 @@

Instance Methods

calendarMode(project, region, body=None, x__xgafv=None)

Advise how, where and when to create the requested amount of instances

+

+ capacity(project, region, body=None, x__xgafv=None)

+

Advice on making real-time decisions (such as choosing zone or

+

+ capacityHistory(project, region, body=None, x__xgafv=None)

+

Gets the capacity history.

close()

Close httplib2 connections.

@@ -201,6 +207,215 @@

Method Details

} +
+ capacity(project, region, body=None, x__xgafv=None) +
Advice on making real-time decisions (such as choosing zone or
+machine types) during deployment to maximize your chances of obtaining
+capacity.
+
+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 provide Assistant Scores. These scores determine VM
+    # obtainability and preemption likelihood.
+  "distributionPolicy": { # Distribution policy. # Policy specifying the distribution of instances across
+      # zones within the requested region.
+    "targetShape": "A String", # Target distribution shape. You can specify the following values:ANY, ANY_SINGLE_ZONE, or BALANCED.
+    "zones": [ # Zones where Capacity Advisor looks for capacity.
+      { # Zone configuration for the distribution policy.
+        "zone": "A String", # The URL of the zone. It can be a
+            # partial or full URL. For example, the following are valid values:
+            #
+            #
+            #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone
+            #    - projects/project/zones/zone
+            #    - zones/zone
+      },
+    ],
+  },
+  "instanceFlexibilityPolicy": { # Specification of alternative, flexible instance configurations. # Policy for instance selectors.
+    "instanceSelections": { # Named instance selections to configure properties.
+        # The key is an arbitrary, unique RFC1035 string that identifies the
+        # instance selection.
+      "a_key": { # Machine specification.
+        "disks": [ # Local SSDs.
+          { # Attached disk configuration.
+            "type": "A String", # Specifies the type of the disk.
+          },
+        ],
+        "guestAccelerators": [ # Accelerators configuration.
+          { # A specification of the type and number of accelerator cards attached to the
+              # instance.
+            "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.
+            "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this
+                # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
+                # If you are creating an instance template, specify only the
+                # accelerator name.
+                # See GPUs on Compute Engine
+                # for a full list of accelerator types.
+          },
+        ],
+        "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
+          "A String",
+        ],
+      },
+    },
+  },
+  "instanceProperties": { # Instance provisioning properties. # Instance properties for this request.
+    "scheduling": { # Defines the instance scheduling options. # Specifies the scheduling options.
+      "provisioningModel": "A String", # Specifies the provisioning model.
+    },
+  },
+  "size": 42, # The number of VM instances to request.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A response contains scoring recommendations.
+  "recommendations": [ # Initially the API will provide one recommendation which balances the
+      # individual scores according to the service provider's preference.
+    { # Recommendation.
+      "scores": { # Groups information about a shard of capacity. # Scores for the recommendation.
+        "estimatedUptime": "A String", # The estimated run time of the majority of Spot VMs in the request
+            # before preemption. The estimate is best-effort only. It is based on
+            # historical data and current conditions.
+        "obtainability": 3.14, # The obtainability score indicates the likelihood of successfully
+            # obtaining (provisioning) the requested number of VMs.
+            # The score range is 0.0 through 1.0. Higher is better.
+      },
+      "shards": [ # Shards represent blocks of uniform capacity in recommendations.
+        { # Shards represent blocks of uniform capacity in recommendations.
+            # Each shard is for a single zone and a single machine shape. Each shard
+            # defines a size expressed as the number of VMs.
+          "instanceCount": 42, # The number of instances.
+          "machineType": "A String", # The machine type corresponds to the instance selection in the request.
+          "provisioningModel": "A String", # The provisioning model that you want to view recommendations for.
+          "zone": "A String", # Output only. The zone name for this shard.
+        },
+      ],
+    },
+  ],
+}
+
+ +
+ capacityHistory(project, region, body=None, x__xgafv=None) +
Gets the capacity history.
+
+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 get the capacity history.
+  "instanceProperties": { # Instance properties for this request. # Instance properties for this request.
+    "machineType": "A String", # The machine type for the VM, such as `n2-standard-4`.
+    "scheduling": { # Scheduling options. # Specifies the scheduling options.
+      "provisioningModel": "A String", # The provisioning model to get capacity history for.
+          # This field must be set to SPOT.
+          #
+          # For more information, see
+          # Compute Engine instances provisioning models.
+    },
+  },
+  "locationPolicy": { # Location policy for this request. # Location policy for this request.
+    "location": "A String", # The region or zone to get capacity history for.
+        #
+        # It can be a partial or full URL. For example, the following are valid
+        # values:
+        #
+        #
+        #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone
+        #    - projects/project/zones/zone
+        #    - zones/zone
+        #
+        #
+        #
+        # This field is optional.
+  },
+  "types": [ # List of history types to get capacity history for.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains the capacity history.
+  "location": "A String", # Output only. The location (region or zone) for which the capacity history is returned.
+      # It is returned as a URL - For example,https://www.googleapis.com/compute/v1/projects/project/zones/zone.
+  "machineType": "A String", # The machine type for which the capacity history is returned.
+  "preemptionHistory": [ # The preemption history for the requested machine type and location.
+    { # A record of Spot VM preemption history.
+      "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a # The time interval for this preemption record.
+          # Timestamp end (exclusive).
+          #
+          # The start must be less than or equal to the end.
+          # When the start equals the end, the interval is empty (matches no time).
+          # When both start and end are unspecified, the interval matches any time.
+        "endTime": "A String", # Optional. Exclusive end of the interval.
+            #
+            # If specified, a Timestamp matching this interval will have to be before the
+            # end.
+        "startTime": "A String", # Optional. Inclusive start of the interval.
+            #
+            # If specified, a Timestamp matching this interval will have to be the same
+            # or after the start.
+      },
+      "preemptionRate": 3.14, # The preemption rate during the interval, representing the fraction of
+          # Spot VMs that were preempted. Range: 0.0 to 1.0. Preemption rate is
+          # calculated as (total preempted Spots) / (total Spots that stopped
+          # running).
+    },
+  ],
+  "priceHistory": [ # The price history for the requested machine type and location.
+    { # A record of price history.
+      "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a # The time interval for this price record.
+          # Timestamp end (exclusive).
+          #
+          # The start must be less than or equal to the end.
+          # When the start equals the end, the interval is empty (matches no time).
+          # When both start and end are unspecified, the interval matches any time.
+        "endTime": "A String", # Optional. Exclusive end of the interval.
+            #
+            # If specified, a Timestamp matching this interval will have to be before the
+            # end.
+        "startTime": "A String", # Optional. Inclusive start of the interval.
+            #
+            # If specified, a Timestamp matching this interval will have to be the same
+            # or after the start.
+      },
+      "listPrice": { # Represents an amount of money with its currency type. # The Spot VM list price during the interval.
+        "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.
+      },
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/compute_v1.backendServices.html b/docs/dyn/compute_v1.backendServices.html index 6f06458562..0f19435b96 100644 --- a/docs/dyn/compute_v1.backendServices.html +++ b/docs/dyn/compute_v1.backendServices.html @@ -1274,7 +1274,8 @@

Method Details

# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -3321,7 +3322,8 @@

Method Details

# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -5114,7 +5116,8 @@

Method Details

# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -6849,7 +6852,8 @@

Method Details

# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -8325,7 +8329,8 @@

Method Details

# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -9741,7 +9746,8 @@

Method Details

# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -12918,7 +12924,8 @@

Method Details

# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, diff --git a/docs/dyn/compute_v1.html b/docs/dyn/compute_v1.html index 22fa931a38..60cda402be 100644 --- a/docs/dyn/compute_v1.html +++ b/docs/dyn/compute_v1.html @@ -359,6 +359,11 @@

Instance Methods

Returns the previewFeatures Resource.

+

+ projectViews() +

+

Returns the projectViews Resource.

+

projects()

diff --git a/docs/dyn/compute_v1.instanceGroupManagers.html b/docs/dyn/compute_v1.instanceGroupManagers.html index ad90f4b7f8..85086ef4a4 100644 --- a/docs/dyn/compute_v1.instanceGroupManagers.html +++ b/docs/dyn/compute_v1.instanceGroupManagers.html @@ -626,6 +626,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", }, @@ -3151,6 +3152,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", }, @@ -3918,6 +3920,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", }, @@ -5062,6 +5065,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", }, @@ -6675,6 +6679,7 @@

Method Details

# instances to apply the configuration. To apply the configuration, set the # group's updatePolicy.type field to use proactive updates or # use the applyUpdatesToInstances method. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID. "labels": { # The label key-value pairs that you want to patch onto the instance. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html index 20456a8649..db7610ff8c 100644 --- a/docs/dyn/compute_v1.instanceTemplates.html +++ b/docs/dyn/compute_v1.instanceTemplates.html @@ -1056,6 +1056,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -2481,6 +2483,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -3886,6 +3890,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -5306,6 +5312,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html index 72297054dc..9036d10c4e 100644 --- a/docs/dyn/compute_v1.instances.html +++ b/docs/dyn/compute_v1.instances.html @@ -2557,6 +2557,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -4947,6 +4949,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -7743,6 +7747,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -10108,6 +10114,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -11777,6 +11785,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -17206,6 +17216,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -21586,6 +21598,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the diff --git a/docs/dyn/compute_v1.machineImages.html b/docs/dyn/compute_v1.machineImages.html index 49c1d7f91a..a293d29510 100644 --- a/docs/dyn/compute_v1.machineImages.html +++ b/docs/dyn/compute_v1.machineImages.html @@ -1244,6 +1244,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -1975,6 +1977,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -3312,6 +3316,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -4043,6 +4049,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -5396,6 +5404,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -6127,6 +6137,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the diff --git a/docs/dyn/compute_v1.projectViews.html b/docs/dyn/compute_v1.projectViews.html new file mode 100644 index 0000000000..dcb86d328d --- /dev/null +++ b/docs/dyn/compute_v1.projectViews.html @@ -0,0 +1,206 @@ + + + +

Compute Engine API . projectViews

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(project, region, x__xgafv=None)

+

Returns the specified global ProjectViews resource, with a regional

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ 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)
+  region: string, Required. Name of the region for this request. This is part of the URL path. (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 ProjectView resource.
+    #
+    # 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
+      # Resource Hierarchy.
+    "cloudArmorTier": "A String", # Output only. [Output Only] The Cloud Armor tier for this project. It can be one of the
+        # following values: CA_STANDARD,CA_ENTERPRISE_PAYGO.
+        #
+        # If this field is not specified, it is assumed to beCA_STANDARD.
+    "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this
+        # project. See Custom
+        # metadata for more information.
+      "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of
+          # the metadata's contents and used for optimistic locking. The
+          # fingerprint is initially generated by Compute Engine and changes after
+          # every request to modify or update metadata. You must always provide an
+          # up-to-date fingerprint hash in order to update or change metadata,
+          # otherwise the request will fail with error412 conditionNotMet.
+          #
+          # To see the latest fingerprint, make a get() request to
+          # retrieve the resource.
+      "items": [ # Array of key/value pairs. The total size of all keys and values must be
+          # less than 512 KB.
+        { # Metadata
+          "key": "A String", # Key for the metadata entry. Keys must conform to the following
+              # regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.
+              # This is reflected as part of a URL in the metadata server. Additionally, to
+              # avoid ambiguity, keys must not conflict with any other metadata keys
+              # for the project.
+          "value": "A String", # Value for the metadata entry. These are free-form strings, and only
+              # have meaning as interpreted by the image running in the instance. The
+              # only restriction placed on values is that their size must be less than
+              # or equal to 262144 bytes (256 KiB).
+        },
+      ],
+      "kind": "compute#metadata", # Output only. [Output Only] Type of the resource. Always compute#metadata
+          # for metadata.
+    },
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
+        # text format.
+    "defaultNetworkTier": "A String", # This signifies the default network tier used for configuring resources of
+        # the project and can only take the following values:PREMIUM, STANDARD. Initially the default network
+        # tier is PREMIUM.
+    "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.
+    "description": "A String", # An optional textual description of the resource.
+    "enabledFeatures": [ # An optional list of restricted features enabled for use on this project.
+      "A String",
+    ],
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+        # defined by the server. This is *not* the project ID, and is
+        # just a unique ID used by Compute Engine to identify resources.
+    "kind": "compute#project", # Output only. [Output Only] Type of the resource. Always compute#project for
+        # projects.
+    "name": "A String", # The project ID. For example: my-example-project. Use the
+        # project ID to make requests to Compute Engine.
+    "quotas": [ # [Output Only] Quotas assigned to this project.
+      { # A quotas entry.
+        "limit": 3.14, # [Output Only] Quota limit for this metric.
+        "metric": "A String", # [Output Only] Name of the quota metric.
+        "owner": "A String", # [Output Only] Owning resource. This is the resource on which this quota
+            # is applied.
+        "usage": 3.14, # [Output Only] Current usage of this metric.
+      },
+    ],
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage # An optional naming prefix for daily usage reports and the Google Cloud
+        # Storage bucket where they are stored.
+        # report. Contains bucket_name and report_name prefix.
+      "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report
+          # object is stored. The Google Service Account is granted write access to
+          # this bucket. This can either be the bucket name by itself, such asexample-bucket, or the bucket name with gs://
+          # or https://storage.googleapis.com/ in front of it, such
+          # as gs://example-bucket.
+      "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored inbucketName. If not supplied, defaults tousage_gce. The report is stored as a CSV file namedreport_name_prefix_gce_YYYYMMDD.csv whereYYYYMMDD is the day of the usage according to Pacific Time.
+          # If you supply a prefix, it should conform to Cloud Storageobject naming
+          # conventions.
+    },
+    "vmDnsSetting": "A String", # Output only. [Output Only] Default internal DNS setting used by VMs running in
+        # this project.
+    "xpnProjectStatus": "A String", # [Output Only] The role this project has in a shared VPC configuration.
+        # Currently, only projects with the host role, which is specified by the
+        # value HOST, are differentiated.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_v1.regionBackendServices.html b/docs/dyn/compute_v1.regionBackendServices.html index 3017485047..d2b68df048 100644 --- a/docs/dyn/compute_v1.regionBackendServices.html +++ b/docs/dyn/compute_v1.regionBackendServices.html @@ -1147,7 +1147,8 @@

Method Details

# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -2923,7 +2924,8 @@

Method Details

# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -4659,7 +4661,8 @@

Method Details

# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -6137,7 +6140,8 @@

Method Details

# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -7554,7 +7558,8 @@

Method Details

# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -10425,7 +10430,8 @@

Method Details

# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, diff --git a/docs/dyn/compute_v1.regionCommitments.html b/docs/dyn/compute_v1.regionCommitments.html index 5bfb84ca4c..e0c4764308 100644 --- a/docs/dyn/compute_v1.regionCommitments.html +++ b/docs/dyn/compute_v1.regionCommitments.html @@ -586,7 +586,7 @@

Method Details

# resource types. # # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, - # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For + # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For # example, type MEMORY_OPTIMIZED specifies a commitment that # applies only to eligible resources of memory optimized M1 and M2 machine # series. Type GENERAL_PURPOSE specifies a commitment that @@ -1068,7 +1068,7 @@

Method Details

# resource types. # # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, - # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For + # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For # example, type MEMORY_OPTIMIZED specifies a commitment that # applies only to eligible resources of memory optimized M1 and M2 machine # series. Type GENERAL_PURPOSE specifies a commitment that @@ -1460,7 +1460,7 @@

Method Details

# resource types. # # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, - # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For + # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For # example, type MEMORY_OPTIMIZED specifies a commitment that # applies only to eligible resources of memory optimized M1 and M2 machine # series. Type GENERAL_PURPOSE specifies a commitment that @@ -2238,7 +2238,7 @@

Method Details

# resource types. # # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, - # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For + # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For # example, type MEMORY_OPTIMIZED specifies a commitment that # applies only to eligible resources of memory optimized M1 and M2 machine # series. Type GENERAL_PURPOSE specifies a commitment that @@ -2681,7 +2681,7 @@

Method Details

# resource types. # # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, - # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For + # COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For # example, type MEMORY_OPTIMIZED specifies a commitment that # applies only to eligible resources of memory optimized M1 and M2 machine # series. Type GENERAL_PURPOSE specifies a commitment that diff --git a/docs/dyn/compute_v1.regionInstanceGroupManagers.html b/docs/dyn/compute_v1.regionInstanceGroupManagers.html index 745bf20efc..1a0bea8783 100644 --- a/docs/dyn/compute_v1.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_v1.regionInstanceGroupManagers.html @@ -2192,6 +2192,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", }, @@ -2956,6 +2957,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", }, @@ -4099,6 +4101,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", }, @@ -5702,6 +5705,7 @@

Method Details

# instances to apply the configuration. To apply the configuration, set the # group's updatePolicy.type field to use proactive updates or # use the applyUpdatesToInstances method. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID. "labels": { # The label key-value pairs that you want to patch onto the instance. "a_key": "A String", }, diff --git a/docs/dyn/compute_v1.regionInstanceTemplates.html b/docs/dyn/compute_v1.regionInstanceTemplates.html index 8d0df7d171..58f4689f6c 100644 --- a/docs/dyn/compute_v1.regionInstanceTemplates.html +++ b/docs/dyn/compute_v1.regionInstanceTemplates.html @@ -1251,6 +1251,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -2286,6 +2288,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -3707,6 +3711,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the diff --git a/docs/dyn/compute_v1.regionInstances.html b/docs/dyn/compute_v1.regionInstances.html index f55da6ac96..a364ea1349 100644 --- a/docs/dyn/compute_v1.regionInstances.html +++ b/docs/dyn/compute_v1.regionInstances.html @@ -1393,6 +1393,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index 8b8eaf65d8..0d272c993e 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -58435,7 +58435,7 @@ } } }, -"revision": "20260828", +"revision": "20260908", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -66029,7 +66029,7 @@ false "type": "string" }, "type": { -"description": "The type of commitment; specifies the\nmachine series for which you want to commit to purchasing resources.\nThe choice of machine series affects the discount rate and the eligible\nresource types.\n\n The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D,\n COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For\nexample, type MEMORY_OPTIMIZED specifies a commitment that\napplies only to eligible resources of memory optimized M1 and M2 machine\nseries. Type GENERAL_PURPOSE specifies a commitment that\napplies only to eligible resources of general purpose N1 machine series.", +"description": "The type of commitment; specifies the\nmachine series for which you want to commit to purchasing resources.\nThe choice of machine series affects the discount rate and the eligible\nresource types.\n\n The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D,\n COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For\nexample, type MEMORY_OPTIMIZED specifies a commitment that\napplies only to eligible resources of memory optimized M1 and M2 machine\nseries. Type GENERAL_PURPOSE specifies a commitment that\napplies only to eligible resources of general purpose N1 machine series.", "enum": [ "ACCELERATOR_OPTIMIZED", "ACCELERATOR_OPTIMIZED_A3", @@ -66081,6 +66081,9 @@ false "NETWORK_OPTIMIZED_U4S", "STORAGE_OPTIMIZED_Z3", "STORAGE_OPTIMIZED_Z4D", +"STORAGE_OPTIMIZED_Z4D4T", +"STORAGE_OPTIMIZED_Z4DH", +"STORAGE_OPTIMIZED_Z4DS", "STORAGE_OPTIMIZED_Z4M", "TYPE_UNSPECIFIED" ], @@ -66135,6 +66138,9 @@ false "CUD bucket for NETWORK_OPTIMIZED_U4S machines.", "", "CUD bucket for Z4D machines.", +"CUD bucket for Z4D-4T machines.", +"CUD bucket for Z4DH machines.", +"CUD bucket for Z4DS machines.", "CUD bucket for Z4M (bare metal) 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." ], diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index e13462f745..12d45a7bb6 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -54280,7 +54280,7 @@ } } }, -"revision": "20260828", +"revision": "20260908", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -61186,7 +61186,7 @@ false "type": "string" }, "type": { -"description": "The type of commitment; specifies the\nmachine series for which you want to commit to purchasing resources.\nThe choice of machine series affects the discount rate and the eligible\nresource types.\n\n The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D,\n COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For\nexample, type MEMORY_OPTIMIZED specifies a commitment that\napplies only to eligible resources of memory optimized M1 and M2 machine\nseries. Type GENERAL_PURPOSE specifies a commitment that\napplies only to eligible resources of general purpose N1 machine series.", +"description": "The type of commitment; specifies the\nmachine series for which you want to commit to purchasing resources.\nThe choice of machine series affects the discount rate and the eligible\nresource types.\n\n The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D,\n COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For\nexample, type MEMORY_OPTIMIZED specifies a commitment that\napplies only to eligible resources of memory optimized M1 and M2 machine\nseries. Type GENERAL_PURPOSE specifies a commitment that\napplies only to eligible resources of general purpose N1 machine series.", "enum": [ "ACCELERATOR_OPTIMIZED", "ACCELERATOR_OPTIMIZED_A3", @@ -61231,6 +61231,9 @@ false "NETWORK_OPTIMIZED_U4P", "NETWORK_OPTIMIZED_U4S", "STORAGE_OPTIMIZED_Z3", +"STORAGE_OPTIMIZED_Z4D4T", +"STORAGE_OPTIMIZED_Z4DH", +"STORAGE_OPTIMIZED_Z4DS", "TYPE_UNSPECIFIED" ], "enumDescriptions": [ @@ -61277,6 +61280,9 @@ false "CUD bucket for NETWORK_OPTIMIZED_U4P machines.", "CUD bucket for NETWORK_OPTIMIZED_U4S machines.", "", +"CUD bucket for Z4D-4T machines.", +"CUD bucket for Z4DH machines.", +"CUD bucket for Z4DS 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." ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index 51e37147bd..34fcfd8510 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -965,6 +965,80 @@ "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", +"httpMethod": "POST", +"id": "compute.advice.capacity", +"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/capacity", +"request": { +"$ref": "CapacityAdviceRequest" +}, +"response": { +"$ref": "CapacityAdviceResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"capacityHistory": { +"description": "Gets the capacity history.", +"flatPath": "projects/{project}/regions/{region}/advice/capacityHistory", +"httpMethod": "POST", +"id": "compute.advice.capacityHistory", +"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/capacityHistory", +"request": { +"$ref": "CapacityHistoryRequest" +}, +"response": { +"$ref": "CapacityHistoryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] } } }, @@ -23189,6 +23263,45 @@ } } }, +"projectViews": { +"methods": { +"get": { +"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", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"project": { +"description": "Required. Project ID for this request. This is part of the URL path.", +"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": "Required. Name of the region for this request. This is part of the URL path.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/projectViews", +"response": { +"$ref": "ProjectView" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, "projects": { "methods": { "disableXpnHost": { @@ -48767,7 +48880,7 @@ } } }, -"revision": "20260821", +"revision": "20260908", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -53350,7 +53463,7 @@ false "id": "BackendServiceHAPolicyLeaderNetworkEndpoint", "properties": { "instance": { -"description": "The name of the VM instance of the leader network endpoint. The\ninstance must already be attached to the NEG specified in the\nhaPolicy.leader.backendGroup.\n\nThe name must be 1-63 characters long, and comply with RFC1035.\nAuthorization requires the following IAM permission on the\nspecified resource instance: compute.instances.use", +"description": "The name of the VM instance of the leader network endpoint. The\ninstance must already be attached to the NEG specified in the\nhaPolicy.leader.backendGroup.\n\nThe value must be a valid RFC1035 name (1-63 characters) or a valid\ninstance URL.\nAuthorization requires the following IAM permission on the\nspecified resource instance: compute.instances.use", "type": "string" } }, @@ -54862,6 +54975,394 @@ false }, "type": "object" }, +"CapacityAdviceRequest": { +"description": "A request to provide Assistant Scores. These scores determine VM\nobtainability and preemption likelihood.", +"id": "CapacityAdviceRequest", +"properties": { +"distributionPolicy": { +"$ref": "CapacityAdviceRequestDistributionPolicy", +"description": "Policy specifying the distribution of instances across\nzones within the requested region." +}, +"instanceFlexibilityPolicy": { +"$ref": "CapacityAdviceRequestInstanceFlexibilityPolicy", +"description": "Policy for instance selectors." +}, +"instanceProperties": { +"$ref": "CapacityAdviceRequestInstanceProperties", +"description": "Instance properties for this request." +}, +"size": { +"description": "The number of VM instances to request.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"CapacityAdviceRequestDistributionPolicy": { +"description": "Distribution policy.", +"id": "CapacityAdviceRequestDistributionPolicy", +"properties": { +"targetShape": { +"description": "Target distribution shape. You can specify the following values:ANY, ANY_SINGLE_ZONE, or BALANCED.", +"enum": [ +"ANY", +"ANY_SINGLE_ZONE", +"BALANCED", +"TARGET_SHAPE_UNSPECIFIED" +], +"enumDescriptions": [ +"Picks zones for creating VM instances to fulfill the requested number\nof VMs within present resource constraints.", +"Creates all VM instances within a single zone. The zone is selected\nbased on the present resource constraints.", +"Prioritizes acquisition of resources, scheduling VMs in zones where\nresources are available while distributing VMs as evenly as possible\nacross selected zones to minimize the impact of zonal failure.", +"Default value, unused." +], +"type": "string" +}, +"zones": { +"description": "Zones where Capacity Advisor looks for capacity.", +"items": { +"$ref": "CapacityAdviceRequestDistributionPolicyZoneConfiguration" +}, +"type": "array" +} +}, +"type": "object" +}, +"CapacityAdviceRequestDistributionPolicyZoneConfiguration": { +"description": "Zone configuration for the distribution policy.", +"id": "CapacityAdviceRequestDistributionPolicyZoneConfiguration", +"properties": { +"zone": { +"description": "The URL of the zone. It can be a\npartial or full URL. For example, the following are valid values: \n \n \n - https://www.googleapis.com/compute/v1/projects/project/zones/zone \n - projects/project/zones/zone \n - zones/zone", +"type": "string" +} +}, +"type": "object" +}, +"CapacityAdviceRequestInstanceFlexibilityPolicy": { +"description": "Specification of alternative, flexible instance configurations.", +"id": "CapacityAdviceRequestInstanceFlexibilityPolicy", +"properties": { +"instanceSelections": { +"additionalProperties": { +"$ref": "CapacityAdviceRequestInstanceFlexibilityPolicyInstanceSelection" +}, +"description": "Named instance selections to configure properties.\nThe key is an arbitrary, unique RFC1035 string that identifies the\ninstance selection.", +"type": "object" +} +}, +"type": "object" +}, +"CapacityAdviceRequestInstanceFlexibilityPolicyInstanceSelection": { +"description": "Machine specification.", +"id": "CapacityAdviceRequestInstanceFlexibilityPolicyInstanceSelection", +"properties": { +"disks": { +"description": "Local SSDs.", +"items": { +"$ref": "CapacityAdviceRequestInstanceFlexibilityPolicyInstanceSelectionAttachedDisk" +}, +"type": "array" +}, +"guestAccelerators": { +"description": "Accelerators configuration.", +"items": { +"$ref": "AcceleratorConfig" +}, +"type": "array" +}, +"machineTypes": { +"description": "Full machine-type names, e.g. \"n1-standard-16\".", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"CapacityAdviceRequestInstanceFlexibilityPolicyInstanceSelectionAttachedDisk": { +"description": "Attached disk configuration.", +"id": "CapacityAdviceRequestInstanceFlexibilityPolicyInstanceSelectionAttachedDisk", +"properties": { +"type": { +"description": "Specifies the type of the disk.", +"enum": [ +"DISK_TYPE_UNSPECIFIED", +"SCRATCH" +], +"enumDescriptions": [ +"Default value, unspecified disk type.", +"Scratch disk (Local SSD)." +], +"type": "string" +} +}, +"type": "object" +}, +"CapacityAdviceRequestInstanceProperties": { +"description": "Instance provisioning properties.", +"id": "CapacityAdviceRequestInstanceProperties", +"properties": { +"scheduling": { +"$ref": "CapacityAdviceRequestInstancePropertiesScheduling", +"description": "Specifies the scheduling options." +} +}, +"type": "object" +}, +"CapacityAdviceRequestInstancePropertiesScheduling": { +"description": "Defines the instance scheduling options.", +"id": "CapacityAdviceRequestInstancePropertiesScheduling", +"properties": { +"provisioningModel": { +"description": "Specifies the provisioning model.", +"enum": [ +"FLEX_START", +"RESERVATION_BOUND", +"SPOT", +"STANDARD" +], +"enumDescriptions": [ +"Instance is provisioned using the Flex Start provisioning model and\nhas a limited runtime.", +"Bound to the lifecycle of the reservation in which it is provisioned.", +"Heavily discounted, no guaranteed runtime.", +"Standard provisioning with user controlled runtime, no discounts." +], +"type": "string" +} +}, +"type": "object" +}, +"CapacityAdviceResponse": { +"description": "A response contains scoring recommendations.", +"id": "CapacityAdviceResponse", +"properties": { +"recommendations": { +"description": "Initially the API will provide one recommendation which balances the\nindividual scores according to the service provider's preference.", +"items": { +"$ref": "CapacityAdviceResponseRecommendation" +}, +"type": "array" +} +}, +"type": "object" +}, +"CapacityAdviceResponseRecommendation": { +"description": "Recommendation.", +"id": "CapacityAdviceResponseRecommendation", +"properties": { +"scores": { +"$ref": "CapacityAdviceResponseRecommendationScores", +"description": "Scores for the recommendation." +}, +"shards": { +"description": "Shards represent blocks of uniform capacity in recommendations.", +"items": { +"$ref": "CapacityAdviceResponseRecommendationShard" +}, +"type": "array" +} +}, +"type": "object" +}, +"CapacityAdviceResponseRecommendationScores": { +"description": "Groups information about a shard of capacity.", +"id": "CapacityAdviceResponseRecommendationScores", +"properties": { +"estimatedUptime": { +"description": "The estimated run time of the majority of Spot VMs in the request\nbefore preemption. The estimate is best-effort only. It is based on\nhistorical data and current conditions.", +"format": "google-duration", +"type": "string" +}, +"obtainability": { +"description": "The obtainability score indicates the likelihood of successfully\nobtaining (provisioning) the requested number of VMs.\nThe score range is 0.0 through 1.0. Higher is better.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"CapacityAdviceResponseRecommendationShard": { +"description": "Shards represent blocks of uniform capacity in recommendations.\nEach shard is for a single zone and a single machine shape. Each shard\ndefines a size expressed as the number of VMs.", +"id": "CapacityAdviceResponseRecommendationShard", +"properties": { +"instanceCount": { +"description": "The number of instances.", +"format": "int32", +"type": "integer" +}, +"machineType": { +"description": "The machine type corresponds to the instance selection in the request.", +"type": "string" +}, +"provisioningModel": { +"description": "The provisioning model that you want to view recommendations for.", +"enum": [ +"FLEX_START", +"RESERVATION_BOUND", +"SPOT", +"STANDARD" +], +"enumDescriptions": [ +"Instance is provisioned using the Flex Start provisioning model and\nhas a limited runtime.", +"Bound to the lifecycle of the reservation in which it is provisioned.", +"Heavily discounted, no guaranteed runtime.", +"Standard provisioning with user controlled runtime, no discounts." +], +"type": "string" +}, +"zone": { +"description": "Output only. The zone name for this shard.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CapacityHistoryRequest": { +"description": "A request to get the capacity history.", +"id": "CapacityHistoryRequest", +"properties": { +"instanceProperties": { +"$ref": "CapacityHistoryRequestInstanceProperties", +"description": "Instance properties for this request." +}, +"locationPolicy": { +"$ref": "CapacityHistoryRequestLocationPolicy", +"description": "Location policy for this request." +}, +"types": { +"description": "List of history types to get capacity history for.", +"items": { +"enum": [ +"HISTORY_TYPE_UNSPECIFIED", +"PREEMPTION", +"PRICE" +], +"enumDescriptions": [ +"Default value, unused.", +"Preemption history.", +"Price history." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"CapacityHistoryRequestInstanceProperties": { +"description": "Instance properties for this request.", +"id": "CapacityHistoryRequestInstanceProperties", +"properties": { +"machineType": { +"description": "The machine type for the VM, such as `n2-standard-4`.", +"type": "string" +}, +"scheduling": { +"$ref": "CapacityHistoryRequestInstancePropertiesScheduling", +"description": "Specifies the scheduling options." +} +}, +"type": "object" +}, +"CapacityHistoryRequestInstancePropertiesScheduling": { +"description": "Scheduling options.", +"id": "CapacityHistoryRequestInstancePropertiesScheduling", +"properties": { +"provisioningModel": { +"description": "The provisioning model to get capacity history for.\nThis field must be set to SPOT.\n\nFor more information, see\nCompute Engine instances provisioning models.", +"enum": [ +"FLEX_START", +"RESERVATION_BOUND", +"SPOT", +"STANDARD" +], +"enumDescriptions": [ +"Instance is provisioned using the Flex Start provisioning model and\nhas a limited runtime.", +"Bound to the lifecycle of the reservation in which it is provisioned.", +"Heavily discounted, no guaranteed runtime.", +"Standard provisioning with user controlled runtime, no discounts." +], +"type": "string" +} +}, +"type": "object" +}, +"CapacityHistoryRequestLocationPolicy": { +"description": "Location policy for this request.", +"id": "CapacityHistoryRequestLocationPolicy", +"properties": { +"location": { +"description": "The region or zone to get capacity history for.\n\nIt can be a partial or full URL. For example, the following are valid\nvalues: \n \n \n - https://www.googleapis.com/compute/v1/projects/project/zones/zone \n - projects/project/zones/zone \n - zones/zone\n\n\n\nThis field is optional.", +"type": "string" +} +}, +"type": "object" +}, +"CapacityHistoryResponse": { +"description": "Contains the capacity history.", +"id": "CapacityHistoryResponse", +"properties": { +"location": { +"description": "Output only. The location (region or zone) for which the capacity history is returned.\nIt is returned as a URL - For example,https://www.googleapis.com/compute/v1/projects/project/zones/zone.", +"readOnly": true, +"type": "string" +}, +"machineType": { +"description": "The machine type for which the capacity history is returned.", +"type": "string" +}, +"preemptionHistory": { +"description": "The preemption history for the requested machine type and location.", +"items": { +"$ref": "CapacityHistoryResponsePreemptionRecord" +}, +"type": "array" +}, +"priceHistory": { +"description": "The price history for the requested machine type and location.", +"items": { +"$ref": "CapacityHistoryResponsePriceRecord" +}, +"type": "array" +} +}, +"type": "object" +}, +"CapacityHistoryResponsePreemptionRecord": { +"description": "A record of Spot VM preemption history.", +"id": "CapacityHistoryResponsePreemptionRecord", +"properties": { +"interval": { +"$ref": "Interval", +"description": "The time interval for this preemption record." +}, +"preemptionRate": { +"description": "The preemption rate during the interval, representing the fraction of\nSpot VMs that were preempted. Range: 0.0 to 1.0. Preemption rate is\ncalculated as (total preempted Spots) / (total Spots that stopped\nrunning).", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"CapacityHistoryResponsePriceRecord": { +"description": "A record of price history.", +"id": "CapacityHistoryResponsePriceRecord", +"properties": { +"interval": { +"$ref": "Interval", +"description": "The time interval for this price record." +}, +"listPrice": { +"$ref": "Money", +"description": "The Spot VM list price during the interval." +} +}, +"type": "object" +}, "CircuitBreakers": { "description": "Settings controlling the volume of requests, connections and retries to this\nbackend service.", "id": "CircuitBreakers", @@ -55049,7 +55550,7 @@ false "type": "string" }, "type": { -"description": "The type of commitment; specifies the\nmachine series for which you want to commit to purchasing resources.\nThe choice of machine series affects the discount rate and the eligible\nresource types.\n\n The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D,\n COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For\nexample, type MEMORY_OPTIMIZED specifies a commitment that\napplies only to eligible resources of memory optimized M1 and M2 machine\nseries. Type GENERAL_PURPOSE specifies a commitment that\napplies only to eligible resources of general purpose N1 machine series.", +"description": "The type of commitment; specifies the\nmachine series for which you want to commit to purchasing resources.\nThe choice of machine series affects the discount rate and the eligible\nresource types.\n\n The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D,\n COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T. For\nexample, type MEMORY_OPTIMIZED specifies a commitment that\napplies only to eligible resources of memory optimized M1 and M2 machine\nseries. Type GENERAL_PURPOSE specifies a commitment that\napplies only to eligible resources of general purpose N1 machine series.", "enum": [ "ACCELERATOR_OPTIMIZED", "ACCELERATOR_OPTIMIZED_A3", @@ -55094,6 +55595,9 @@ false "NETWORK_OPTIMIZED_U4P", "NETWORK_OPTIMIZED_U4S", "STORAGE_OPTIMIZED_Z3", +"STORAGE_OPTIMIZED_Z4D4T", +"STORAGE_OPTIMIZED_Z4DH", +"STORAGE_OPTIMIZED_Z4DS", "TYPE_UNSPECIFIED" ], "enumDescriptions": [ @@ -55140,6 +55644,9 @@ false "CUD bucket for NETWORK_OPTIMIZED_U4P machines.", "CUD bucket for NETWORK_OPTIMIZED_U4S machines.", "", +"CUD bucket for Z4D-4T machines.", +"CUD bucket for Z4DH machines.", +"CUD bucket for Z4DS 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." ], "type": "string" @@ -62879,6 +63386,7 @@ false "description": "The ID of a supported feature. To add multiple values, use commas to\nseparate values. Set to one or more of the following values:\n \n - VIRTIO_SCSI_MULTIQUEUE\n - WINDOWS\n - MULTI_IP_SUBNET\n - UEFI_COMPATIBLE\n - GVNIC\n - SEV_CAPABLE\n - SUSPEND_RESUME_COMPATIBLE\n - SEV_LIVE_MIGRATABLE_V2\n - SEV_SNP_CAPABLE\n - TDX_CAPABLE\n - IDPF\n - SNP_SVSM_CAPABLE\n - CCA_CAPABLE\n - SUSPEND_SAFE_FPR\n\n\nFor more information, see\nEnabling guest operating system features.", "enum": [ "BARE_METAL_LINUX_COMPATIBLE", +"BMSAI_CAPABLE", "CCA_CAPABLE", "FEATURE_TYPE_UNSPECIFIED", "GVNIC", @@ -62898,6 +63406,7 @@ false ], "enumDescriptions": [ "", +"Indicates the guest OS is capable of Bare Metal Secure AI (BMSAI)\nconfidential computing.", "", "", "", @@ -71237,6 +71746,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" @@ -76932,6 +77445,23 @@ false }, "type": "object" }, +"Interval": { +"description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a\nTimestamp end (exclusive).\n\nThe start must be less than or equal to the end.\nWhen the start equals the end, the interval is empty (matches no time).\nWhen both start and end are unspecified, the interval matches any time.", +"id": "Interval", +"properties": { +"endTime": { +"description": "Optional. Exclusive end of the interval.\n\nIf specified, a Timestamp matching this interval will have to be before the\nend.", +"format": "google-datetime", +"type": "string" +}, +"startTime": { +"description": "Optional. Inclusive start of the interval.\n\nIf specified, a Timestamp matching this interval will have to be the same\nor after the start.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "License": { "description": "Represents a License resource.\n\nA License represents billing and aggregate usage data forpublic andmarketplace images.\n *Caution* This resource is intended for\nuse only by third-party partners who are creatingCloud Marketplace\nimages.", "id": "License", @@ -78951,6 +79481,27 @@ false }, "type": "object" }, +"Money": { +"description": "Represents an amount of money with its currency type.", +"id": "Money", +"properties": { +"currencyCode": { +"description": "The three-letter currency code defined in ISO 4217.", +"type": "string" +}, +"nanos": { +"description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", +"format": "int32", +"type": "integer" +}, +"units": { +"description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "NamedPort": { "description": "The named port. For example: <\"http\", 80>.", "id": "NamedPort", @@ -87745,6 +88296,17 @@ false }, "type": "object" }, +"ProjectView": { +"description": "Represents a ProjectView resource.\n\nA ProjectView resource contains read-only project data which is available\nglobally.", +"id": "ProjectView", +"properties": { +"project": { +"$ref": "Project", +"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" +}, "ProjectsDisableXpnResourceRequest": { "id": "ProjectsDisableXpnResourceRequest", "properties": { @@ -98422,6 +98984,10 @@ false "format": "int32", "type": "integer" }, +"exposeHostTopology": { +"description": "This optional flag exposes the hashed physical host ID in the\nResourceStatus resource of the VM.", +"type": "boolean" +}, "gracefulShutdown": { "$ref": "SchedulingGracefulShutdown" }, From d52b02d78bbd725b5cec059624dc9dc0845dd939 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:29 +0000 Subject: [PATCH 11/30] feat(container): update the api #### container:v1 The following keys were added: - schemas.AddonsConfig.properties.parallelstoreCsiDriverConfig.deprecated (Total Keys: 1) - schemas.NodeKubeletConfig.properties.reservedResourcesConfig.$ref (Total Keys: 1) - schemas.ParallelstoreCsiDriverConfig.deprecated (Total Keys: 1) - schemas.ReservedResourcesConfig (Total Keys: 12) #### container:v1beta1 The following keys were added: - schemas.AdditionalNodeNetworkConfig.properties.stackType.type (Total Keys: 1) - schemas.AddonsConfig.properties.parallelstoreCsiDriverConfig.deprecated (Total Keys: 1) - schemas.NodeKubeletConfig.properties.reservedResourcesConfig.$ref (Total Keys: 1) - schemas.ParallelstoreCsiDriverConfig.deprecated (Total Keys: 1) - schemas.ReservedResourcesConfig (Total Keys: 12) --- ...tainer_v1.projects.locations.clusters.html | 94 +++++++++++++++++- ...projects.locations.clusters.nodePools.html | 24 +++++ .../container_v1.projects.zones.clusters.html | 94 +++++++++++++++++- ..._v1.projects.zones.clusters.nodePools.html | 24 +++++ ...r_v1beta1.projects.locations.clusters.html | 97 ++++++++++++++++++- ...projects.locations.clusters.nodePools.html | 28 ++++++ ...ainer_v1beta1.projects.zones.clusters.html | 97 ++++++++++++++++++- ...ta1.projects.zones.clusters.nodePools.html | 28 ++++++ .../documents/container.v1.json | 41 +++++++- .../documents/container.v1beta1.json | 57 ++++++++++- 10 files changed, 558 insertions(+), 26 deletions(-) diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index e0714076c2..b7ad137583 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -398,7 +398,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. @@ -985,6 +985,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1249,6 +1255,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1376,6 +1388,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1568,6 +1586,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -2198,7 +2222,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. @@ -2785,6 +2809,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -3049,6 +3079,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -3176,6 +3212,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -3368,6 +3410,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -3855,7 +3903,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. @@ -4442,6 +4490,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -4706,6 +4760,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -4833,6 +4893,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -5025,6 +5091,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -5472,7 +5544,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. @@ -6419,7 +6491,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. @@ -6795,6 +6867,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -6850,6 +6928,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html index 6922623001..9d4749e06b 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html @@ -332,6 +332,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -981,6 +987,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1452,6 +1464,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -2211,6 +2229,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index ca29dededd..bea1dfd7b4 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -201,7 +201,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. @@ -512,7 +512,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. @@ -1099,6 +1099,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1363,6 +1369,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1490,6 +1502,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1682,6 +1700,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -2312,7 +2336,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. @@ -2899,6 +2923,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -3163,6 +3193,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -3290,6 +3326,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -3482,6 +3524,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -4013,7 +4061,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. @@ -4600,6 +4648,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -4864,6 +4918,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -4991,6 +5051,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -5183,6 +5249,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -6446,7 +6518,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. @@ -6822,6 +6894,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -6877,6 +6955,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html index 81801ff0e3..ae4bb567f6 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html @@ -397,6 +397,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1046,6 +1052,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1517,6 +1529,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -2201,6 +2219,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index f5fcbd4e96..e55b763d30 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -405,7 +405,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Configuration for the Pod Snapshot feature. @@ -1023,6 +1023,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1289,6 +1295,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1424,6 +1436,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1631,6 +1649,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1824,6 +1848,7 @@

Method Details

"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs + "stackType": "A String", # Optional. Additional NIC stack type, configured by the client. "subnetwork": "A String", # Name of the subnetwork where the additional interface belongs }, ], @@ -2294,7 +2319,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Configuration for the Pod Snapshot feature. @@ -2912,6 +2937,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -3178,6 +3209,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -3313,6 +3350,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -3520,6 +3563,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -3713,6 +3762,7 @@

Method Details

"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs + "stackType": "A String", # Optional. Additional NIC stack type, configured by the client. "subnetwork": "A String", # Name of the subnetwork where the additional interface belongs }, ], @@ -4040,7 +4090,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Configuration for the Pod Snapshot feature. @@ -4658,6 +4708,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -4924,6 +4980,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -5059,6 +5121,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -5266,6 +5334,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -5459,6 +5533,7 @@

Method Details

"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs + "stackType": "A String", # Optional. Additional NIC stack type, configured by the client. "subnetwork": "A String", # Name of the subnetwork where the additional interface belongs }, ], @@ -5746,7 +5821,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Configuration for the Pod Snapshot feature. @@ -6700,7 +6775,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Configuration for the Pod Snapshot feature. @@ -7098,6 +7173,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -7153,6 +7234,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index b78e2bf846..86fe5f89d4 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -344,6 +344,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -537,6 +543,7 @@

Method Details

"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs + "stackType": "A String", # Optional. Additional NIC stack type, configured by the client. "subnetwork": "A String", # Name of the subnetwork where the additional interface belongs }, ], @@ -1008,6 +1015,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1201,6 +1214,7 @@

Method Details

"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs + "stackType": "A String", # Optional. Additional NIC stack type, configured by the client. "subnetwork": "A String", # Name of the subnetwork where the additional interface belongs }, ], @@ -1494,6 +1508,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1687,6 +1707,7 @@

Method Details

"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs + "stackType": "A String", # Optional. Additional NIC stack type, configured by the client. "subnetwork": "A String", # Name of the subnetwork where the additional interface belongs }, ], @@ -2257,6 +2278,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -2350,6 +2377,7 @@

Method Details

"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs + "stackType": "A String", # Optional. Additional NIC stack type, configured by the client. "subnetwork": "A String", # Name of the subnetwork where the additional interface belongs }, ], diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index 3c3a9fa626..35e1160a45 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -208,7 +208,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Configuration for the Pod Snapshot feature. @@ -526,7 +526,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Configuration for the Pod Snapshot feature. @@ -1144,6 +1144,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1410,6 +1416,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1545,6 +1557,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1752,6 +1770,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1945,6 +1969,7 @@

Method Details

"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs + "stackType": "A String", # Optional. Additional NIC stack type, configured by the client. "subnetwork": "A String", # Name of the subnetwork where the additional interface belongs }, ], @@ -2415,7 +2440,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Configuration for the Pod Snapshot feature. @@ -3033,6 +3058,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -3299,6 +3330,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -3434,6 +3471,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -3641,6 +3684,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -3834,6 +3883,7 @@

Method Details

"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs + "stackType": "A String", # Optional. Additional NIC stack type, configured by the client. "subnetwork": "A String", # Name of the subnetwork where the additional interface belongs }, ], @@ -4205,7 +4255,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Configuration for the Pod Snapshot feature. @@ -4823,6 +4873,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -5089,6 +5145,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -5224,6 +5286,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -5431,6 +5499,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -5624,6 +5698,7 @@

Method Details

"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs + "stackType": "A String", # Optional. Additional NIC stack type, configured by the client. "subnetwork": "A String", # Name of the subnetwork where the additional interface belongs }, ], @@ -6727,7 +6802,7 @@

Method Details

"nodeReadinessConfig": { # Configuration for the GKE Node Readiness Controller. # Optional. Configuration for NodeReadinessController add-on. "enabled": True or False, # Optional. Whether the GKE Node Readiness Controller is enabled for this cluster. }, - "parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. + "parallelstoreCsiDriverConfig": { # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. # Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Configuration for the Pod Snapshot feature. @@ -7125,6 +7200,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -7180,6 +7261,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index db1f8ec465..46d4b8fd98 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -409,6 +409,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -602,6 +608,7 @@

Method Details

"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs + "stackType": "A String", # Optional. Additional NIC stack type, configured by the client. "subnetwork": "A String", # Name of the subnetwork where the additional interface belongs }, ], @@ -1073,6 +1080,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1266,6 +1279,7 @@

Method Details

"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs + "stackType": "A String", # Optional. Additional NIC stack type, configured by the client. "subnetwork": "A String", # Name of the subnetwork where the additional interface belongs }, ], @@ -1559,6 +1573,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -1752,6 +1772,7 @@

Method Details

"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs + "stackType": "A String", # Optional. Additional NIC stack type, configured by the client. "subnetwork": "A String", # Name of the subnetwork where the additional interface belongs }, ], @@ -2247,6 +2268,12 @@

Method Details

"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. }, "podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. + "reservedResourcesConfig": { # ReservedResourcesConfig contains the configuration for the reserved resources on the node. # Optional. Controls the reserved resources on the node. Only included if any fields are specified. + "cpuReservedMillicore": "A String", # Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + "effectiveCpuReservedMillicore": "A String", # Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. + "effectiveMemoryReservedMib": "A String", # Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. + "memoryReservedMib": "A String", # Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. + }, "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. @@ -2340,6 +2367,7 @@

Method Details

"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs + "stackType": "A String", # Optional. Additional NIC stack type, configured by the client. "subnetwork": "A String", # Name of the subnetwork where the additional interface belongs }, ], diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index 4e504c7efb..b896eb7ae0 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2811,7 +2811,7 @@ } } }, -"revision": "20260818", +"revision": "20260901", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3012,7 +3012,8 @@ }, "parallelstoreCsiDriverConfig": { "$ref": "ParallelstoreCsiDriverConfig", -"description": "Configuration for the Cloud Storage Parallelstore CSI driver." +"deprecated": true, +"description": "Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver." }, "podSnapshotConfig": { "$ref": "PodSnapshotConfig", @@ -7554,6 +7555,10 @@ false "format": "int64", "type": "string" }, +"reservedResourcesConfig": { +"$ref": "ReservedResourcesConfig", +"description": "Optional. Controls the reserved resources on the node. Only included if any fields are specified." +}, "shutdownGracePeriodCriticalPodsSeconds": { "description": "Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].", "format": "int32", @@ -8312,7 +8317,8 @@ false "type": "object" }, "ParallelstoreCsiDriverConfig": { -"description": "Configuration for the Cloud Storage Parallelstore CSI driver.", +"deprecated": true, +"description": "Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver.", "id": "ParallelstoreCsiDriverConfig", "properties": { "enabled": { @@ -8826,6 +8832,35 @@ false }, "type": "object" }, +"ReservedResourcesConfig": { +"description": "ReservedResourcesConfig contains the configuration for the reserved resources on the node.", +"id": "ReservedResourcesConfig", +"properties": { +"cpuReservedMillicore": { +"description": "Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula.", +"format": "int64", +"type": "string" +}, +"effectiveCpuReservedMillicore": { +"description": "Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"effectiveMemoryReservedMib": { +"description": "Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"memoryReservedMib": { +"description": "Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "ResourceLabels": { "description": "Collection of [Resource Manager labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels).", "id": "ResourceLabels", diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index dd59d4dbd5..663dc43f8f 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2837,7 +2837,7 @@ } } }, -"revision": "20260818", +"revision": "20260901", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2925,6 +2925,22 @@ "description": "Name of the VPC where the additional interface belongs", "type": "string" }, +"stackType": { +"description": "Optional. Additional NIC stack type, configured by the client.", +"enum": [ +"STACK_TYPE_UNSPECIFIED", +"IPV4", +"IPV4_IPV6", +"IPV6" +], +"enumDescriptions": [ +"Unspecified stack type.", +"IPv4 stack type.", +"IPv4/IPv6 stack type.", +"IPv6 stack type." +], +"type": "string" +}, "subnetwork": { "description": "Name of the subnetwork where the additional interface belongs", "type": "string" @@ -3054,7 +3070,8 @@ }, "parallelstoreCsiDriverConfig": { "$ref": "ParallelstoreCsiDriverConfig", -"description": "Configuration for the Cloud Storage Parallelstore CSI driver." +"deprecated": true, +"description": "Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver." }, "podSnapshotConfig": { "$ref": "PodSnapshotConfig", @@ -7962,6 +7979,10 @@ false "format": "int64", "type": "string" }, +"reservedResourcesConfig": { +"$ref": "ReservedResourcesConfig", +"description": "Optional. Controls the reserved resources on the node. Only included if any fields are specified." +}, "shutdownGracePeriodCriticalPodsSeconds": { "description": "Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].", "format": "int32", @@ -8752,7 +8773,8 @@ false "type": "object" }, "ParallelstoreCsiDriverConfig": { -"description": "Configuration for the Cloud Storage Parallelstore CSI driver.", +"deprecated": true, +"description": "Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver.", "id": "ParallelstoreCsiDriverConfig", "properties": { "enabled": { @@ -9321,6 +9343,35 @@ false }, "type": "object" }, +"ReservedResourcesConfig": { +"description": "ReservedResourcesConfig contains the configuration for the reserved resources on the node.", +"id": "ReservedResourcesConfig", +"properties": { +"cpuReservedMillicore": { +"description": "Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula.", +"format": "int64", +"type": "string" +}, +"effectiveCpuReservedMillicore": { +"description": "Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"effectiveMemoryReservedMib": { +"description": "Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"memoryReservedMib": { +"description": "Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "ResourceLabels": { "description": "Collection of [Resource Manager labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels).", "id": "ResourceLabels", From 1220419093236c7e60aaa6f7804b08176b278863 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:29 +0000 Subject: [PATCH 12/30] feat(dataform): update the api #### dataform:v1 The following keys were added: - schemas.BigQueryUnitTest (Total Keys: 26) - schemas.CompilationResultAction.properties.bigqueryUnitTest.$ref (Total Keys: 1) - schemas.EndUserAuthConfig (Total Keys: 3) - schemas.EndUserAuthenticationConfig (Total Keys: 5) - schemas.InvocationConfig.properties.endUserAuthConfig.$ref (Total Keys: 1) - schemas.InvocationConfig.properties.executionMode.type (Total Keys: 1) - schemas.OAuthConfig (Total Keys: 4) - schemas.Repository.properties.endUserAuthConfig.$ref (Total Keys: 1) - schemas.WorkflowInvocationAction.properties.bigqueryUnitTestAction (Total Keys: 2) #### dataform:v1beta1 The following keys were added: - schemas.BigQueryUnitTest (Total Keys: 26) - schemas.CompilationResultAction.properties.bigqueryUnitTest.$ref (Total Keys: 1) - schemas.EndUserAuthConfig (Total Keys: 3) - schemas.EndUserAuthenticationConfig (Total Keys: 5) - schemas.InvocationConfig.properties.endUserAuthConfig.$ref (Total Keys: 1) - schemas.InvocationConfig.properties.executionMode.type (Total Keys: 1) - schemas.OAuthConfig (Total Keys: 4) - schemas.Repository.properties.endUserAuthConfig.$ref (Total Keys: 1) - schemas.WorkflowInvocationAction.properties.bigqueryUnitTestAction (Total Keys: 2) --- ...ataform_v1.projects.locations.folders.html | 7 + docs/dyn/dataform_v1.projects.locations.html | 7 + ...tions.repositories.compilationResults.html | 16 ++ ...rm_v1.projects.locations.repositories.html | 42 +++++ ...ocations.repositories.workflowConfigs.html | 54 +++++++ ...ions.repositories.workflowInvocations.html | 44 +++++ ...orm_v1.projects.locations.teamFolders.html | 7 + ...rm_v1beta1.projects.locations.folders.html | 7 + .../dataform_v1beta1.projects.locations.html | 7 + ...tions.repositories.compilationResults.html | 16 ++ ...beta1.projects.locations.repositories.html | 42 +++++ ...ocations.repositories.workflowConfigs.html | 54 +++++++ ...ions.repositories.workflowInvocations.html | 44 +++++ ...1beta1.projects.locations.teamFolders.html | 7 + .../documents/dataform.v1.json | 152 +++++++++++++++++- .../documents/dataform.v1beta1.json | 152 +++++++++++++++++- 16 files changed, 656 insertions(+), 2 deletions(-) diff --git a/docs/dyn/dataform_v1.projects.locations.folders.html b/docs/dyn/dataform_v1.projects.locations.folders.html index 62f4fc3aa2..eb7d4f61ad 100644 --- a/docs/dyn/dataform_v1.projects.locations.folders.html +++ b/docs/dyn/dataform_v1.projects.locations.folders.html @@ -398,6 +398,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. diff --git a/docs/dyn/dataform_v1.projects.locations.html b/docs/dyn/dataform_v1.projects.locations.html index 3409d2bbb9..96ea5932ce 100644 --- a/docs/dyn/dataform_v1.projects.locations.html +++ b/docs/dyn/dataform_v1.projects.locations.html @@ -260,6 +260,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.compilationResults.html b/docs/dyn/dataform_v1.projects.locations.repositories.compilationResults.html index cf58dd8683..f652ff09b6 100644 --- a/docs/dyn/dataform_v1.projects.locations.repositories.compilationResults.html +++ b/docs/dyn/dataform_v1.projects.locations.repositories.compilationResults.html @@ -463,6 +463,22 @@

Method Details

"A String", ], }, + "bigqueryUnitTest": { # Represents a BigQuery unit test. # The unit test executed by this action. + "dependencyTargets": [ # A list of actions that this action depends on. + { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. + }, + ], + "disabled": True or False, # Whether this action is disabled (i.e. should not be run). + "displayName": "A String", # The name of the unit test. + "expectedOutputQuery": "A String", # Expected output query to compare against the test query. + "tags": [ # Arbitrary, user-defined tags on this action. + "A String", + ], + "testQuery": "A String", # Test query to execute. + }, "canonicalTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result. "database": "A String", # Optional. The action's database (Google Cloud project ID) . "name": "A String", # Optional. The action's name, within `database` and `schema`. diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.html b/docs/dyn/dataform_v1.projects.locations.repositories.html index cbda653a0d..2f019bb289 100644 --- a/docs/dyn/dataform_v1.projects.locations.repositories.html +++ b/docs/dyn/dataform_v1.projects.locations.repositories.html @@ -239,6 +239,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. @@ -284,6 +291,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. @@ -421,6 +435,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. @@ -514,6 +535,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. @@ -621,6 +649,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. @@ -666,6 +701,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.workflowConfigs.html b/docs/dyn/dataform_v1.projects.locations.repositories.workflowConfigs.html index 6bbe69f4f9..62043c93e3 100644 --- a/docs/dyn/dataform_v1.projects.locations.repositories.workflowConfigs.html +++ b/docs/dyn/dataform_v1.projects.locations.repositories.workflowConfigs.html @@ -116,6 +116,15 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of workflow invocations. "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -168,6 +177,15 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of workflow invocations. "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -244,6 +262,15 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of workflow invocations. "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -310,6 +337,15 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of workflow invocations. "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -379,6 +415,15 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of workflow invocations. "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -431,6 +476,15 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of workflow invocations. "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.workflowInvocations.html b/docs/dyn/dataform_v1.projects.locations.repositories.workflowInvocations.html index bd01a95770..4aefc791d7 100644 --- a/docs/dyn/dataform_v1.projects.locations.repositories.workflowInvocations.html +++ b/docs/dyn/dataform_v1.projects.locations.repositories.workflowInvocations.html @@ -147,6 +147,15 @@

Method Details

}, "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -195,6 +204,15 @@

Method Details

}, "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -268,6 +286,15 @@

Method Details

}, "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -333,6 +360,15 @@

Method Details

}, "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -407,6 +443,14 @@

Method Details

"jobId": "A String", # Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run. "sqlScript": "A String", # Output only. The generated BigQuery SQL script that will be executed. }, + "bigqueryUnitTestAction": { # Represents a workflow action that will run a BigQuery unit test. # Output only. The workflow action's unit test details. + "actualResultsJobId": "A String", # Output only. Job ID for the actual results. + "actualResultsSqlScript": "A String", # Output only. SQL script for the actual results. + "expectedResultsJobId": "A String", # Output only. Job ID for the expected results. + "expectedResultsSqlScript": "A String", # Output only. SQL script for the expected results. + "totalBilledBytes": "A String", # Output only. Total bytes billed for this action. Combined total for actual and expected jobs. + "totalProcessedBytes": "A String", # Output only. Total bytes processed for this action. Combined total for actual and expected jobs. + }, "canonicalTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result. "database": "A String", # Optional. The action's database (Google Cloud project ID) . "name": "A String", # Optional. The action's name, within `database` and `schema`. diff --git a/docs/dyn/dataform_v1.projects.locations.teamFolders.html b/docs/dyn/dataform_v1.projects.locations.teamFolders.html index ce681c038b..c03c69409e 100644 --- a/docs/dyn/dataform_v1.projects.locations.teamFolders.html +++ b/docs/dyn/dataform_v1.projects.locations.teamFolders.html @@ -349,6 +349,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.folders.html b/docs/dyn/dataform_v1beta1.projects.locations.folders.html index 990db703f2..70d17391ff 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.folders.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.folders.html @@ -399,6 +399,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.html b/docs/dyn/dataform_v1beta1.projects.locations.html index 2cf84cf1bb..d8be3748df 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.html @@ -260,6 +260,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html index a71285f6fb..941491d7a2 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html @@ -463,6 +463,22 @@

Method Details

"A String", ], }, + "bigqueryUnitTest": { # Represents a BigQuery unit test. # The unit test executed by this action. + "dependencyTargets": [ # A list of actions that this action depends on. + { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. + "database": "A String", # Optional. The action's database (Google Cloud project ID) . + "name": "A String", # Optional. The action's name, within `database` and `schema`. + "schema": "A String", # Optional. The action's schema (BigQuery dataset ID), within `database`. + }, + ], + "disabled": True or False, # Whether this action is disabled (i.e. should not be run). + "displayName": "A String", # The name of the unit test. + "expectedOutputQuery": "A String", # Expected output query to compare against the test query. + "tags": [ # Arbitrary, user-defined tags on this action. + "A String", + ], + "testQuery": "A String", # Test query to execute. + }, "canonicalTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result. "database": "A String", # Optional. The action's database (Google Cloud project ID) . "name": "A String", # Optional. The action's name, within `database` and `schema`. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html index 11cef5aec4..b72e8d44bb 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html @@ -242,6 +242,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. @@ -287,6 +294,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. @@ -466,6 +480,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. @@ -559,6 +580,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. @@ -666,6 +694,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. @@ -711,6 +746,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowConfigs.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowConfigs.html index 653f3e47f0..45b53c06e2 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowConfigs.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowConfigs.html @@ -116,6 +116,15 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of workflow invocations. "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -200,6 +209,15 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of workflow invocations. "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -308,6 +326,15 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of workflow invocations. "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -406,6 +433,15 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of workflow invocations. "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -507,6 +543,15 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of workflow invocations. "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -591,6 +636,15 @@

Method Details

"disabled": True or False, # Optional. Disables automatic creation of workflow invocations. "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowInvocations.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowInvocations.html index 7762d1bec2..e16cbd96b3 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowInvocations.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workflowInvocations.html @@ -147,6 +147,15 @@

Method Details

}, "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -195,6 +204,15 @@

Method Details

}, "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -268,6 +286,15 @@

Method Details

}, "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -333,6 +360,15 @@

Method Details

}, "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used. + "endUserAuthConfig": { # Includes configuration options for end user authentication. # Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + "userEmail": "A String", # Output only. Email address of the user to run workflow invocations under. + }, + "executionMode": "A String", # Optional. Specifies the execution mode for the workflow invocation. "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed. "includedTags": [ # Optional. The set of tags to include. "A String", @@ -407,6 +443,14 @@

Method Details

"jobId": "A String", # Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run. "sqlScript": "A String", # Output only. The generated BigQuery SQL script that will be executed. }, + "bigqueryUnitTestAction": { # Represents a workflow action that will run a BigQuery unit test. # Output only. The workflow action's unit test details. + "actualResultsJobId": "A String", # Output only. Job ID for the actual results. + "actualResultsSqlScript": "A String", # Output only. SQL script for the actual results. + "expectedResultsJobId": "A String", # Output only. Job ID for the expected results. + "expectedResultsSqlScript": "A String", # Output only. SQL script for the expected results. + "totalBilledBytes": "A String", # Output only. Total bytes billed for this action. Combined total for actual and expected jobs. + "totalProcessedBytes": "A String", # Output only. Total bytes processed for this action. Combined total for actual and expected jobs. + }, "canonicalTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result. "database": "A String", # Optional. The action's database (Google Cloud project ID) . "name": "A String", # Optional. The action's name, within `database` and `schema`. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html b/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html index f23b9f8d18..8ff82df609 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html @@ -350,6 +350,13 @@

Method Details

"kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted. }, "displayName": "A String", # Optional. The repository's user-friendly name. + "endUserAuthConfig": { # Includes configuration options for repository end user authentication. # Optional. Includes configuration options for end user authentication. + "oauthConfig": { # OAuth configuration for end user authentication. # Optional. OAuth configuration for repository end user authentication. + "additionalOauthScopes": [ # Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery` + "A String", + ], + }, + }, "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set, `main` will be used. diff --git a/googleapiclient/discovery_cache/documents/dataform.v1.json b/googleapiclient/discovery_cache/documents/dataform.v1.json index e33635cb13..f943fba9c5 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1.json @@ -3220,7 +3220,7 @@ } } }, -"revision": "20260802", +"revision": "20260906", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { @@ -3352,6 +3352,82 @@ }, "type": "object" }, +"BigQueryUnitTest": { +"description": "Represents a BigQuery unit test.", +"id": "BigQueryUnitTest", +"properties": { +"dependencyTargets": { +"description": "A list of actions that this action depends on.", +"items": { +"$ref": "Target" +}, +"type": "array" +}, +"disabled": { +"description": "Whether this action is disabled (i.e. should not be run).", +"type": "boolean" +}, +"displayName": { +"description": "The name of the unit test.", +"type": "string" +}, +"expectedOutputQuery": { +"description": "Expected output query to compare against the test query.", +"type": "string" +}, +"tags": { +"description": "Arbitrary, user-defined tags on this action.", +"items": { +"type": "string" +}, +"type": "array" +}, +"testQuery": { +"description": "Test query to execute.", +"type": "string" +} +}, +"type": "object" +}, +"BigQueryUnitTestAction": { +"description": "Represents a workflow action that will run a BigQuery unit test.", +"id": "BigQueryUnitTestAction", +"properties": { +"actualResultsJobId": { +"description": "Output only. Job ID for the actual results.", +"readOnly": true, +"type": "string" +}, +"actualResultsSqlScript": { +"description": "Output only. SQL script for the actual results.", +"readOnly": true, +"type": "string" +}, +"expectedResultsJobId": { +"description": "Output only. Job ID for the expected results.", +"readOnly": true, +"type": "string" +}, +"expectedResultsSqlScript": { +"description": "Output only. SQL script for the expected results.", +"readOnly": true, +"type": "string" +}, +"totalBilledBytes": { +"description": "Output only. Total bytes billed for this action. Combined total for actual and expected jobs.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"totalProcessedBytes": { +"description": "Output only. Total bytes processed for this action. Combined total for actual and expected jobs.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -3693,6 +3769,10 @@ "$ref": "Assertion", "description": "The assertion executed by this action." }, +"bigqueryUnitTest": { +"$ref": "BigQueryUnitTest", +"description": "The unit test executed by this action." +}, "canonicalTarget": { "$ref": "Target", "description": "The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result." @@ -3923,6 +4003,33 @@ "properties": {}, "type": "object" }, +"EndUserAuthConfig": { +"description": "Includes configuration options for repository end user authentication.", +"id": "EndUserAuthConfig", +"properties": { +"oauthConfig": { +"$ref": "OAuthConfig", +"description": "Optional. OAuth configuration for repository end user authentication." +} +}, +"type": "object" +}, +"EndUserAuthenticationConfig": { +"description": "Includes configuration options for end user authentication.", +"id": "EndUserAuthenticationConfig", +"properties": { +"oauthConfig": { +"$ref": "OAuthConfig", +"description": "Optional. OAuth configuration for end user authentication." +}, +"userEmail": { +"description": "Output only. Email address of the user to run workflow invocations under.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ErrorTable": { "description": "Error table information, used to write error data into a BigQuery table.", "id": "ErrorTable", @@ -4330,6 +4437,26 @@ "description": "Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included.", "id": "InvocationConfig", "properties": { +"endUserAuthConfig": { +"$ref": "EndUserAuthenticationConfig", +"description": "Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used." +}, +"executionMode": { +"description": "Optional. Specifies the execution mode for the workflow invocation.", +"enum": [ +"EXECUTION_MODE_UNSPECIFIED", +"DEFAULT", +"ALL_EXCEPT_UNIT_TESTS", +"UNIT_TESTS_ONLY" +], +"enumDescriptions": [ +"Default value.", +"Default execution mode, which runs all actions except unit tests. Same as ALL_EXCEPT_UNIT_TESTS.", +"Run all actions except unit tests.", +"Run unit tests only." +], +"type": "string" +}, "fullyRefreshIncrementalTablesEnabled": { "description": "Optional. When set to true, any incremental tables will be fully refreshed.", "type": "boolean" @@ -4778,6 +4905,20 @@ }, "type": "object" }, +"OAuthConfig": { +"description": "OAuth configuration for end user authentication.", +"id": "OAuthConfig", +"properties": { +"additionalOauthScopes": { +"description": "Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery`", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -5425,6 +5566,10 @@ "description": "Optional. The repository's user-friendly name.", "type": "string" }, +"endUserAuthConfig": { +"$ref": "EndUserAuthConfig", +"description": "Optional. Includes configuration options for end user authentication." +}, "gitRemoteSettings": { "$ref": "GitRemoteSettings", "description": "Optional. If set, configures this repository to be linked to a Git remote." @@ -5963,6 +6108,11 @@ "description": "Output only. The workflow action's bigquery action details.", "readOnly": true }, +"bigqueryUnitTestAction": { +"$ref": "BigQueryUnitTestAction", +"description": "Output only. The workflow action's unit test details.", +"readOnly": true +}, "canonicalTarget": { "$ref": "Target", "description": "Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.", diff --git a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json index 3faa6c6f4d..a0c8f966a4 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json @@ -3428,7 +3428,7 @@ } } }, -"revision": "20260826", +"revision": "20260906", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { @@ -3560,6 +3560,82 @@ }, "type": "object" }, +"BigQueryUnitTest": { +"description": "Represents a BigQuery unit test.", +"id": "BigQueryUnitTest", +"properties": { +"dependencyTargets": { +"description": "A list of actions that this action depends on.", +"items": { +"$ref": "Target" +}, +"type": "array" +}, +"disabled": { +"description": "Whether this action is disabled (i.e. should not be run).", +"type": "boolean" +}, +"displayName": { +"description": "The name of the unit test.", +"type": "string" +}, +"expectedOutputQuery": { +"description": "Expected output query to compare against the test query.", +"type": "string" +}, +"tags": { +"description": "Arbitrary, user-defined tags on this action.", +"items": { +"type": "string" +}, +"type": "array" +}, +"testQuery": { +"description": "Test query to execute.", +"type": "string" +} +}, +"type": "object" +}, +"BigQueryUnitTestAction": { +"description": "Represents a workflow action that will run a BigQuery unit test.", +"id": "BigQueryUnitTestAction", +"properties": { +"actualResultsJobId": { +"description": "Output only. Job ID for the actual results.", +"readOnly": true, +"type": "string" +}, +"actualResultsSqlScript": { +"description": "Output only. SQL script for the actual results.", +"readOnly": true, +"type": "string" +}, +"expectedResultsJobId": { +"description": "Output only. Job ID for the expected results.", +"readOnly": true, +"type": "string" +}, +"expectedResultsSqlScript": { +"description": "Output only. SQL script for the expected results.", +"readOnly": true, +"type": "string" +}, +"totalBilledBytes": { +"description": "Output only. Total bytes billed for this action. Combined total for actual and expected jobs.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"totalProcessedBytes": { +"description": "Output only. Total bytes processed for this action. Combined total for actual and expected jobs.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -3935,6 +4011,10 @@ "$ref": "Assertion", "description": "The assertion executed by this action." }, +"bigqueryUnitTest": { +"$ref": "BigQueryUnitTest", +"description": "The unit test executed by this action." +}, "canonicalTarget": { "$ref": "Target", "description": "The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result." @@ -4197,6 +4277,33 @@ "properties": {}, "type": "object" }, +"EndUserAuthConfig": { +"description": "Includes configuration options for repository end user authentication.", +"id": "EndUserAuthConfig", +"properties": { +"oauthConfig": { +"$ref": "OAuthConfig", +"description": "Optional. OAuth configuration for repository end user authentication." +} +}, +"type": "object" +}, +"EndUserAuthenticationConfig": { +"description": "Includes configuration options for end user authentication.", +"id": "EndUserAuthenticationConfig", +"properties": { +"oauthConfig": { +"$ref": "OAuthConfig", +"description": "Optional. OAuth configuration for end user authentication." +}, +"userEmail": { +"description": "Output only. Email address of the user to run workflow invocations under.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ErrorTable": { "description": "Error table information, used to write error data into a BigQuery table.", "id": "ErrorTable", @@ -4633,6 +4740,26 @@ "description": "Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included.", "id": "InvocationConfig", "properties": { +"endUserAuthConfig": { +"$ref": "EndUserAuthenticationConfig", +"description": "Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used." +}, +"executionMode": { +"description": "Optional. Specifies the execution mode for the workflow invocation.", +"enum": [ +"EXECUTION_MODE_UNSPECIFIED", +"DEFAULT", +"ALL_EXCEPT_UNIT_TESTS", +"UNIT_TESTS_ONLY" +], +"enumDescriptions": [ +"Default value.", +"Default execution mode, which runs all actions except unit tests. Same as ALL_EXCEPT_UNIT_TESTS.", +"Run all actions except unit tests.", +"Run unit tests only." +], +"type": "string" +}, "fullyRefreshIncrementalTablesEnabled": { "description": "Optional. When set to true, any incremental tables will be fully refreshed.", "type": "boolean" @@ -5081,6 +5208,20 @@ }, "type": "object" }, +"OAuthConfig": { +"description": "OAuth configuration for end user authentication.", +"id": "OAuthConfig", +"properties": { +"additionalOauthScopes": { +"description": "Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery`", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -5728,6 +5869,10 @@ "description": "Optional. The repository's user-friendly name.", "type": "string" }, +"endUserAuthConfig": { +"$ref": "EndUserAuthConfig", +"description": "Optional. Includes configuration options for end user authentication." +}, "gitRemoteSettings": { "$ref": "GitRemoteSettings", "description": "Optional. If set, configures this repository to be linked to a Git remote." @@ -6327,6 +6472,11 @@ "description": "Output only. The workflow action's bigquery action details.", "readOnly": true }, +"bigqueryUnitTestAction": { +"$ref": "BigQueryUnitTestAction", +"description": "Output only. The workflow action's unit test details.", +"readOnly": true +}, "canonicalTarget": { "$ref": "Target", "description": "Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.", From c82021baf1c4adc97dbf8f38d8bb9ca3e22c95cc Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:29 +0000 Subject: [PATCH 13/30] feat(datamanager): update the api #### datamanager:v1 The following keys were added: - schemas.AdEvent.properties.ipAddress.type (Total Keys: 1) - schemas.AdIdentifiers.properties.ppid.type (Total Keys: 1) - schemas.AdIdentifiers.properties.visitorPpid.type (Total Keys: 1) --- ...ger_v1.accountTypes.accounts.insights.html | 38 +- ...v1.accountTypes.accounts.partnerLinks.html | 164 +- ...Types.accounts.userListDirectLicenses.html | 458 +++--- ...Types.accounts.userListGlobalLicenses.html | 434 ++--- ...es.userListGlobalLicenseCustomerInfos.html | 90 +- ...er_v1.accountTypes.accounts.userLists.html | 568 +++---- docs/dyn/datamanager_v1.adEvents.html | 171 +- docs/dyn/datamanager_v1.audienceMembers.html | 410 ++--- docs/dyn/datamanager_v1.events.html | 362 +++-- docs/dyn/datamanager_v1.requestStatus.html | 192 +-- .../documents/datamanager.v1.json | 1444 ++++++----------- 11 files changed, 1897 insertions(+), 2434 deletions(-) diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.insights.html b/docs/dyn/datamanager_v1.accountTypes.accounts.insights.html index 0009595cef..280c01c06d 100644 --- a/docs/dyn/datamanager_v1.accountTypes.accounts.insights.html +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.insights.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Retrieves marketing data insights for a given user list. This feature is only available to data partners. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`

+

Method Details

close() @@ -88,23 +88,23 @@

Method Details

retrieve(parent, body=None, x__xgafv=None) -
Retrieves marketing data insights for a given user list. This feature is only available to data partners. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
+  
 
 Args:
-  parent: string, Required. The parent account that owns the user list. Format: `accountTypes/{account_type}/accounts/{account}` (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for DM API MarketingDataInsightsService.RetrieveInsights
-  "baseline": { # Baseline criteria against which insights are compared. # Required. Baseline for the insights requested.
-    "baselineLocation": { # The baseline location of the request. Baseline location is on OR-list of ISO 3166-1 alpha-2 region codes of the requested regions. # The baseline location of the request. Baseline location is an OR-list of the requested regions.
-      "regionCodes": [ # List of ISO 3166-1 alpha-2 region codes.
+{
+  "baseline": {
+    "baselineLocation": {
+      "regionCodes": [
         "A String",
       ],
     },
-    "locationAutoDetectionEnabled": True or False, # If set to true, the service will try to automatically detect the baseline location for insights.
+    "locationAutoDetectionEnabled": True or False,
   },
-  "userListId": "A String", # Required. The user list ID for which insights are requested.
+  "userListId": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -115,18 +115,18 @@ 

Method Details

Returns: An object of the form: - { # Response message for DM API MarketingDataInsightsService.RetrieveInsights - "marketingDataInsights": [ # Contains the insights for the marketing data. - { # Insights for marketing data. This feature is only available to data partners. - "attributes": [ # Insights for values of a given dimension. - { # Insights for a collection of related attributes of the same dimension. - "ageRange": "A String", # Age range of the audience for which the lift is provided. - "gender": "A String", # Gender of the audience for which the lift is provided. - "lift": 3.14, # Measure of lift that the audience has for the attribute value as compared to the baseline. Range [0-1]. - "userInterestId": "A String", # The user interest ID. + { + "marketingDataInsights": [ + { + "attributes": [ + { + "ageRange": "A String", + "gender": "A String", + "lift": 3.14, + "userInterestId": "A String", }, ], - "dimension": "A String", # The dimension to which the insight belongs. + "dimension": "A String", }, ], }
diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html b/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html index fd9530e15a..b9a5b15ac4 100644 --- a/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html @@ -79,13 +79,13 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a partner link for the given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}`

+

delete(name, x__xgafv=None)

-

Deletes a partner link for the given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}`

+

search(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Searches for all partner links to and from a given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}`

+

search_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -97,38 +97,38 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a partner link for the given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}`
+  
 
 Args:
-  parent: string, Required. The parent, which owns this collection of partner links. Format: accountTypes/{account_type}/accounts/{account} (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A partner link between an owning account and a partner account.
-  "featureSet": "A String", # Optional. Immutable. The set of features supported for the partner link. If not specified, the system behavior defaults to FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT.
-  "name": "A String", # Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}
-  "owningAccount": { # Represents a specific account. # Required. The owning account granting access to the partner 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.
+{
+  "featureSet": "A String",
+  "name": "A String",
+  "owningAccount": {
+    "accountId": "A String",
+    "accountType": "A String",
+    "product": "A String",
   },
-  "partnerAccount": { # Represents a specific account. # Required. The partner account granted access by the owning 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.
+  "partnerAccount": {
+    "accountId": "A String",
+    "accountType": "A String",
+    "product": "A String",
   },
-  "partnerCustomerAccount": { # Represents a customer account in the partner's system. # Optional. The customer account in the partner system. This is required for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set.
-    "accountId": "A String", # Required. The identifier of the customer account in the partner's ID space.
-    "accountName": "A String", # Optional. The name of the account.
-    "accountType": "A String", # Optional. The type of the account. Can be used to distinguish between advertiser accounts and business level accounts, for example.
+  "partnerCustomerAccount": {
+    "accountId": "A String",
+    "accountName": "A String",
+    "accountType": "A String",
   },
-  "partnerLinkId": "A String", # Output only. The partner link ID.
-  "partnerLinkMetadata": { # Represents metadata associated with a partner link. # Optional. Metadata associated with the partner link. This is optional and only accepted for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT.
-    "implicitAccounts": [ # Optional. The list of implicit accounts.
-      { # Represents a customer account in the partner's system.
-        "accountId": "A String", # Required. The identifier of the customer account in the partner's ID space.
-        "accountName": "A String", # Optional. The name of the account.
-        "accountType": "A String", # Optional. The type of the account. Can be used to distinguish between advertiser accounts and business level accounts, for example.
+  "partnerLinkId": "A String",
+  "partnerLinkMetadata": {
+    "implicitAccounts": [
+      {
+        "accountId": "A String",
+        "accountName": "A String",
+        "accountType": "A String",
       },
     ],
   },
@@ -142,31 +142,31 @@ 

Method Details

Returns: An object of the form: - { # A partner link between an owning account and a partner account. - "featureSet": "A String", # Optional. Immutable. The set of features supported for the partner link. If not specified, the system behavior defaults to FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT. - "name": "A String", # Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link} - "owningAccount": { # Represents a specific account. # Required. The owning account granting access to the partner 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. + { + "featureSet": "A String", + "name": "A String", + "owningAccount": { + "accountId": "A String", + "accountType": "A String", + "product": "A String", }, - "partnerAccount": { # Represents a specific account. # Required. The partner account granted access by the owning 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. + "partnerAccount": { + "accountId": "A String", + "accountType": "A String", + "product": "A String", }, - "partnerCustomerAccount": { # Represents a customer account in the partner's system. # Optional. The customer account in the partner system. This is required for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set. - "accountId": "A String", # Required. The identifier of the customer account in the partner's ID space. - "accountName": "A String", # Optional. The name of the account. - "accountType": "A String", # Optional. The type of the account. Can be used to distinguish between advertiser accounts and business level accounts, for example. + "partnerCustomerAccount": { + "accountId": "A String", + "accountName": "A String", + "accountType": "A String", }, - "partnerLinkId": "A String", # Output only. The partner link ID. - "partnerLinkMetadata": { # Represents metadata associated with a partner link. # Optional. Metadata associated with the partner link. This is optional and only accepted for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT. - "implicitAccounts": [ # Optional. The list of implicit accounts. - { # Represents a customer account in the partner's system. - "accountId": "A String", # Required. The identifier of the customer account in the partner's ID space. - "accountName": "A String", # Optional. The name of the account. - "accountType": "A String", # Optional. The type of the account. Can be used to distinguish between advertiser accounts and business level accounts, for example. + "partnerLinkId": "A String", + "partnerLinkMetadata": { + "implicitAccounts": [ + { + "accountId": "A String", + "accountName": "A String", + "accountType": "A String", }, ], }, @@ -175,10 +175,10 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a partner link for the given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}`
+  
 
 Args:
-  name: string, Required. The resource name of the partner link to delete. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link} (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -187,19 +187,19 @@ 

Method Details

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); } + { }
search(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Searches for all partner links to and from a given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}`
+  
 
 Args:
-  parent: string, Required. Account to search for partner links. If no `filter` is specified, all partner links where this account is either the `owning_account` or `partner_account` are returned. Format: `accountTypes/{account_type}/accounts/{account}` (required)
-  filter: string, Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` - `feature_set` For partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set, the following fields are also supported: - `partner_customer_account.account_id` - `partner_link_metadata.implicit_accounts.account_id` Example: `owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321`
-  pageSize: integer, The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 50 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.
-  pageToken: string, A page token, received from a previous `SearchPartnerLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchPartnerLinks` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  filter: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -208,34 +208,34 @@ 

Method Details

Returns: An object of the form: - { # Response from the SearchPartnerLinksRequest. - "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. - "partnerLinks": [ # The partner links for the given account. - { # A partner link between an owning account and a partner account. - "featureSet": "A String", # Optional. Immutable. The set of features supported for the partner link. If not specified, the system behavior defaults to FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT. - "name": "A String", # Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link} - "owningAccount": { # Represents a specific account. # Required. The owning account granting access to the partner 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. + { + "nextPageToken": "A String", + "partnerLinks": [ + { + "featureSet": "A String", + "name": "A String", + "owningAccount": { + "accountId": "A String", + "accountType": "A String", + "product": "A String", }, - "partnerAccount": { # Represents a specific account. # Required. The partner account granted access by the owning 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. + "partnerAccount": { + "accountId": "A String", + "accountType": "A String", + "product": "A String", }, - "partnerCustomerAccount": { # Represents a customer account in the partner's system. # Optional. The customer account in the partner system. This is required for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set. - "accountId": "A String", # Required. The identifier of the customer account in the partner's ID space. - "accountName": "A String", # Optional. The name of the account. - "accountType": "A String", # Optional. The type of the account. Can be used to distinguish between advertiser accounts and business level accounts, for example. + "partnerCustomerAccount": { + "accountId": "A String", + "accountName": "A String", + "accountType": "A String", }, - "partnerLinkId": "A String", # Output only. The partner link ID. - "partnerLinkMetadata": { # Represents metadata associated with a partner link. # Optional. Metadata associated with the partner link. This is optional and only accepted for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT. - "implicitAccounts": [ # Optional. The list of implicit accounts. - { # Represents a customer account in the partner's system. - "accountId": "A String", # Required. The identifier of the customer account in the partner's ID space. - "accountName": "A String", # Optional. The name of the account. - "accountType": "A String", # Optional. The type of the account. Can be used to distinguish between advertiser accounts and business level accounts, for example. + "partnerLinkId": "A String", + "partnerLinkMetadata": { + "implicitAccounts": [ + { + "accountId": "A String", + "accountName": "A String", + "accountType": "A String", }, ], }, diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userListDirectLicenses.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userListDirectLicenses.html index 3d34632e3e..2c07479dcd 100644 --- a/docs/dyn/datamanager_v1.accountTypes.accounts.userListDirectLicenses.html +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userListDirectLicenses.html @@ -79,19 +79,19 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a user list direct license. This feature is only available to data partners.

+

get(name, x__xgafv=None)

-

Retrieves a user list direct license. This feature is only available to data partners.

+

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

-

Lists all user list direct licenses owned by the parent account. This feature is only available to data partners.

+

list_next(previous_request, previous_response)

Retrieves the next page of results.

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

-

Updates a user list direct license. This feature is only available to data partners.

+

Method Details

close() @@ -100,52 +100,52 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a user list direct license. This feature is only available to data partners.
+  
 
 Args:
-  parent: string, Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A user list direct license. This feature is only available to data partners.
-  "clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only.
-  "clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to.
-  "clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to.
-  "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only.
-    { # A user list license pricing.
-      "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
-      "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`.
-      "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
-      "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
-      "endTime": "A String", # Optional. End time of the pricing.
-      "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap.
-      "pricingActive": True or False, # Output only. Whether this pricing is active.
-      "pricingId": "A String", # Output only. The ID of this pricing.
-      "startTime": "A String", # Output only. Start time of the pricing.
+{
+  "clientAccountDisplayName": "A String",
+  "clientAccountId": "A String",
+  "clientAccountType": "A String",
+  "historicalPricings": [
+    {
+      "buyerApprovalState": "A String",
+      "costMicros": "A String",
+      "costType": "A String",
+      "currencyCode": "A String",
+      "endTime": "A String",
+      "maxCostMicros": "A String",
+      "pricingActive": True or False,
+      "pricingId": "A String",
+      "startTime": "A String",
     },
   ],
-  "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call
-    "clickCount": "A String", # Output only. The number of clicks for the user list license.
-    "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.
-    "impressionCount": "A String", # Output only. The number of impressions for the user list license.
-    "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros.
-    "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.
+  "metrics": {
+    "clickCount": "A String",
+    "endDate": "A String",
+    "impressionCount": "A String",
+    "revenueUsdMicros": "A String",
+    "startDate": "A String",
   },
-  "name": "A String", # Identifier. The resource name of the user list direct license.
-  "pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing.
-    "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
-    "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`.
-    "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
-    "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
-    "endTime": "A String", # Optional. End time of the pricing.
-    "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap.
-    "pricingActive": True or False, # Output only. Whether this pricing is active.
-    "pricingId": "A String", # Output only. The ID of this pricing.
-    "startTime": "A String", # Output only. Start time of the pricing.
+  "name": "A String",
+  "pricing": {
+    "buyerApprovalState": "A String",
+    "costMicros": "A String",
+    "costType": "A String",
+    "currencyCode": "A String",
+    "endTime": "A String",
+    "maxCostMicros": "A String",
+    "pricingActive": True or False,
+    "pricingId": "A String",
+    "startTime": "A String",
   },
-  "status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED.
-  "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only.
-  "userListId": "A String", # Immutable. ID of the user list being licensed.
+  "status": "A String",
+  "userListDisplayName": "A String",
+  "userListId": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -156,54 +156,54 @@ 

Method Details

Returns: An object of the form: - { # A user list direct license. This feature is only available to data partners. - "clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only. - "clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to. - "clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to. - "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. - { # A user list license pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + { + "clientAccountDisplayName": "A String", + "clientAccountId": "A String", + "clientAccountType": "A String", + "historicalPricings": [ + { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, ], - "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call - "clickCount": "A String", # Output only. The number of clicks for the user list license. - "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. - "impressionCount": "A String", # Output only. The number of impressions for the user list license. - "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. - "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "metrics": { + "clickCount": "A String", + "endDate": "A String", + "impressionCount": "A String", + "revenueUsdMicros": "A String", + "startDate": "A String", }, - "name": "A String", # Identifier. The resource name of the user list direct license. - "pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + "name": "A String", + "pricing": { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, - "status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED. - "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. - "userListId": "A String", # Immutable. ID of the user list being licensed. + "status": "A String", + "userListDisplayName": "A String", + "userListId": "A String", }
get(name, x__xgafv=None) -
Retrieves a user list direct license. This feature is only available to data partners.
+  
 
 Args:
-  name: string, Required. The resource name of the user list direct license. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -212,57 +212,57 @@ 

Method Details

Returns: An object of the form: - { # A user list direct license. This feature is only available to data partners. - "clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only. - "clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to. - "clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to. - "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. - { # A user list license pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + { + "clientAccountDisplayName": "A String", + "clientAccountId": "A String", + "clientAccountType": "A String", + "historicalPricings": [ + { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, ], - "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call - "clickCount": "A String", # Output only. The number of clicks for the user list license. - "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. - "impressionCount": "A String", # Output only. The number of impressions for the user list license. - "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. - "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "metrics": { + "clickCount": "A String", + "endDate": "A String", + "impressionCount": "A String", + "revenueUsdMicros": "A String", + "startDate": "A String", }, - "name": "A String", # Identifier. The resource name of the user list direct license. - "pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + "name": "A String", + "pricing": { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, - "status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED. - "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. - "userListId": "A String", # Immutable. ID of the user list being licensed. + "status": "A String", + "userListDisplayName": "A String", + "userListId": "A String", }
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all user list direct licenses owned by the parent account. This feature is only available to data partners.
+  
 
 Args:
-  parent: string, Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} (required)
-  filter: string, Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(user_list_id, 123, 456)` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`
-  pageSize: integer, Optional. The maximum number of licenses to return per page. The service may return fewer than this value. If unspecified, at most 50 licenses 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 `ListUserListDirectLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  filter: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -271,48 +271,48 @@ 

Method Details

Returns: An object of the form: - { # Response from the ListUserListDirectLicensesRequest. - "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. - "userListDirectLicenses": [ # The licenses for the given user list in the request. - { # A user list direct license. This feature is only available to data partners. - "clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only. - "clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to. - "clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to. - "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. - { # A user list license pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + { + "nextPageToken": "A String", + "userListDirectLicenses": [ + { + "clientAccountDisplayName": "A String", + "clientAccountId": "A String", + "clientAccountType": "A String", + "historicalPricings": [ + { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, ], - "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call - "clickCount": "A String", # Output only. The number of clicks for the user list license. - "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. - "impressionCount": "A String", # Output only. The number of impressions for the user list license. - "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. - "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "metrics": { + "clickCount": "A String", + "endDate": "A String", + "impressionCount": "A String", + "revenueUsdMicros": "A String", + "startDate": "A String", }, - "name": "A String", # Identifier. The resource name of the user list direct license. - "pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + "name": "A String", + "pricing": { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, - "status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED. - "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. - "userListId": "A String", # Immutable. ID of the user list being licensed. + "status": "A String", + "userListDisplayName": "A String", + "userListId": "A String", }, ], }
@@ -334,55 +334,55 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a user list direct license. This feature is only available to data partners.
+  
 
 Args:
-  name: string, Identifier. The resource name of the user list direct license. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A user list direct license. This feature is only available to data partners.
-  "clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only.
-  "clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to.
-  "clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to.
-  "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only.
-    { # A user list license pricing.
-      "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
-      "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`.
-      "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
-      "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
-      "endTime": "A String", # Optional. End time of the pricing.
-      "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap.
-      "pricingActive": True or False, # Output only. Whether this pricing is active.
-      "pricingId": "A String", # Output only. The ID of this pricing.
-      "startTime": "A String", # Output only. Start time of the pricing.
+{
+  "clientAccountDisplayName": "A String",
+  "clientAccountId": "A String",
+  "clientAccountType": "A String",
+  "historicalPricings": [
+    {
+      "buyerApprovalState": "A String",
+      "costMicros": "A String",
+      "costType": "A String",
+      "currencyCode": "A String",
+      "endTime": "A String",
+      "maxCostMicros": "A String",
+      "pricingActive": True or False,
+      "pricingId": "A String",
+      "startTime": "A String",
     },
   ],
-  "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call
-    "clickCount": "A String", # Output only. The number of clicks for the user list license.
-    "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.
-    "impressionCount": "A String", # Output only. The number of impressions for the user list license.
-    "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros.
-    "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.
+  "metrics": {
+    "clickCount": "A String",
+    "endDate": "A String",
+    "impressionCount": "A String",
+    "revenueUsdMicros": "A String",
+    "startDate": "A String",
   },
-  "name": "A String", # Identifier. The resource name of the user list direct license.
-  "pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing.
-    "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
-    "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`.
-    "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
-    "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
-    "endTime": "A String", # Optional. End time of the pricing.
-    "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap.
-    "pricingActive": True or False, # Output only. Whether this pricing is active.
-    "pricingId": "A String", # Output only. The ID of this pricing.
-    "startTime": "A String", # Output only. Start time of the pricing.
+  "name": "A String",
+  "pricing": {
+    "buyerApprovalState": "A String",
+    "costMicros": "A String",
+    "costType": "A String",
+    "currencyCode": "A String",
+    "endTime": "A String",
+    "maxCostMicros": "A String",
+    "pricingActive": True or False,
+    "pricingId": "A String",
+    "startTime": "A String",
   },
-  "status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED.
-  "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only.
-  "userListId": "A String", # Immutable. ID of the user list being licensed.
+  "status": "A String",
+  "userListDisplayName": "A String",
+  "userListId": "A String",
 }
 
-  updateMask: string, Optional. The list of fields to update. The special character `*` is not supported and an `INVALID_UPDATE_MASK` error will be thrown if used.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -391,45 +391,45 @@ 

Method Details

Returns: An object of the form: - { # A user list direct license. This feature is only available to data partners. - "clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only. - "clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to. - "clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to. - "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. - { # A user list license pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + { + "clientAccountDisplayName": "A String", + "clientAccountId": "A String", + "clientAccountType": "A String", + "historicalPricings": [ + { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, ], - "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call - "clickCount": "A String", # Output only. The number of clicks for the user list license. - "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. - "impressionCount": "A String", # Output only. The number of impressions for the user list license. - "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. - "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "metrics": { + "clickCount": "A String", + "endDate": "A String", + "impressionCount": "A String", + "revenueUsdMicros": "A String", + "startDate": "A String", }, - "name": "A String", # Identifier. The resource name of the user list direct license. - "pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + "name": "A String", + "pricing": { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, - "status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED. - "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. - "userListId": "A String", # Immutable. ID of the user list being licensed. + "status": "A String", + "userListDisplayName": "A String", + "userListId": "A String", }
diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.html index 0ffc418ced..0dcf4a9815 100644 --- a/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.html +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.html @@ -84,19 +84,19 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a user list global license. This feature is only available to data partners.

+

get(name, x__xgafv=None)

-

Retrieves a user list global license. This feature is only available to data partners.

+

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

-

Lists all user list global licenses owned by the parent account. This feature is only available to data partners.

+

list_next(previous_request, previous_response)

Retrieves the next page of results.

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

-

Updates a user list global license. This feature is only available to data partners.

+

Method Details

close() @@ -105,50 +105,50 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a user list global license. This feature is only available to data partners.
+  
 
 Args:
-  parent: string, Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A user list global license. This feature is only available to data partners.
-  "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only.
-    { # A user list license pricing.
-      "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
-      "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`.
-      "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
-      "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
-      "endTime": "A String", # Optional. End time of the pricing.
-      "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap.
-      "pricingActive": True or False, # Output only. Whether this pricing is active.
-      "pricingId": "A String", # Output only. The ID of this pricing.
-      "startTime": "A String", # Output only. Start time of the pricing.
+{
+  "historicalPricings": [
+    {
+      "buyerApprovalState": "A String",
+      "costMicros": "A String",
+      "costType": "A String",
+      "currencyCode": "A String",
+      "endTime": "A String",
+      "maxCostMicros": "A String",
+      "pricingActive": True or False,
+      "pricingId": "A String",
+      "startTime": "A String",
     },
   ],
-  "licenseType": "A String", # Immutable. Product type of client customer which the user list is being licensed to.
-  "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call
-    "clickCount": "A String", # Output only. The number of clicks for the user list license.
-    "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.
-    "impressionCount": "A String", # Output only. The number of impressions for the user list license.
-    "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros.
-    "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.
+  "licenseType": "A String",
+  "metrics": {
+    "clickCount": "A String",
+    "endDate": "A String",
+    "impressionCount": "A String",
+    "revenueUsdMicros": "A String",
+    "startDate": "A String",
   },
-  "name": "A String", # Identifier. The resource name of the user list global license.
-  "pricing": { # A user list license pricing. # Optional. UserListGlobalLicense pricing.
-    "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
-    "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`.
-    "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
-    "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
-    "endTime": "A String", # Optional. End time of the pricing.
-    "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap.
-    "pricingActive": True or False, # Output only. Whether this pricing is active.
-    "pricingId": "A String", # Output only. The ID of this pricing.
-    "startTime": "A String", # Output only. Start time of the pricing.
+  "name": "A String",
+  "pricing": {
+    "buyerApprovalState": "A String",
+    "costMicros": "A String",
+    "costType": "A String",
+    "currencyCode": "A String",
+    "endTime": "A String",
+    "maxCostMicros": "A String",
+    "pricingActive": True or False,
+    "pricingId": "A String",
+    "startTime": "A String",
   },
-  "status": "A String", # Optional. Status of UserListGlobalLicense - ENABLED or DISABLED.
-  "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only.
-  "userListId": "A String", # Immutable. ID of the user list being licensed.
+  "status": "A String",
+  "userListDisplayName": "A String",
+  "userListId": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -159,52 +159,52 @@ 

Method Details

Returns: An object of the form: - { # A user list global license. This feature is only available to data partners. - "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. - { # A user list license pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + { + "historicalPricings": [ + { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, ], - "licenseType": "A String", # Immutable. Product type of client customer which the user list is being licensed to. - "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call - "clickCount": "A String", # Output only. The number of clicks for the user list license. - "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. - "impressionCount": "A String", # Output only. The number of impressions for the user list license. - "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. - "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "licenseType": "A String", + "metrics": { + "clickCount": "A String", + "endDate": "A String", + "impressionCount": "A String", + "revenueUsdMicros": "A String", + "startDate": "A String", }, - "name": "A String", # Identifier. The resource name of the user list global license. - "pricing": { # A user list license pricing. # Optional. UserListGlobalLicense pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + "name": "A String", + "pricing": { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, - "status": "A String", # Optional. Status of UserListGlobalLicense - ENABLED or DISABLED. - "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. - "userListId": "A String", # Immutable. ID of the user list being licensed. + "status": "A String", + "userListDisplayName": "A String", + "userListId": "A String", }
get(name, x__xgafv=None) -
Retrieves a user list global license. This feature is only available to data partners.
+  
 
 Args:
-  name: string, Required. The resource name of the user list global license. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -213,55 +213,55 @@ 

Method Details

Returns: An object of the form: - { # A user list global license. This feature is only available to data partners. - "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. - { # A user list license pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + { + "historicalPricings": [ + { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, ], - "licenseType": "A String", # Immutable. Product type of client customer which the user list is being licensed to. - "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call - "clickCount": "A String", # Output only. The number of clicks for the user list license. - "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. - "impressionCount": "A String", # Output only. The number of impressions for the user list license. - "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. - "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "licenseType": "A String", + "metrics": { + "clickCount": "A String", + "endDate": "A String", + "impressionCount": "A String", + "revenueUsdMicros": "A String", + "startDate": "A String", }, - "name": "A String", # Identifier. The resource name of the user list global license. - "pricing": { # A user list license pricing. # Optional. UserListGlobalLicense pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + "name": "A String", + "pricing": { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, - "status": "A String", # Optional. Status of UserListGlobalLicense - ENABLED or DISABLED. - "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. - "userListId": "A String", # Immutable. ID of the user list being licensed. + "status": "A String", + "userListDisplayName": "A String", + "userListId": "A String", }
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all user list global licenses owned by the parent account. This feature is only available to data partners.
+  
 
 Args:
-  parent: string, Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} (required)
-  filter: string, Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(user_list_id, 123, 456)` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`
-  pageSize: integer, Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses 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 `ListUserListGlobalLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  filter: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -270,46 +270,46 @@ 

Method Details

Returns: An object of the form: - { # Response from the ListUserListGlobalLicensesRequest. - "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. - "userListGlobalLicenses": [ # The licenses for the given user list in the request. - { # A user list global license. This feature is only available to data partners. - "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. - { # A user list license pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + { + "nextPageToken": "A String", + "userListGlobalLicenses": [ + { + "historicalPricings": [ + { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, ], - "licenseType": "A String", # Immutable. Product type of client customer which the user list is being licensed to. - "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call - "clickCount": "A String", # Output only. The number of clicks for the user list license. - "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. - "impressionCount": "A String", # Output only. The number of impressions for the user list license. - "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. - "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "licenseType": "A String", + "metrics": { + "clickCount": "A String", + "endDate": "A String", + "impressionCount": "A String", + "revenueUsdMicros": "A String", + "startDate": "A String", }, - "name": "A String", # Identifier. The resource name of the user list global license. - "pricing": { # A user list license pricing. # Optional. UserListGlobalLicense pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + "name": "A String", + "pricing": { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, - "status": "A String", # Optional. Status of UserListGlobalLicense - ENABLED or DISABLED. - "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. - "userListId": "A String", # Immutable. ID of the user list being licensed. + "status": "A String", + "userListDisplayName": "A String", + "userListId": "A String", }, ], }
@@ -331,53 +331,53 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a user list global license. This feature is only available to data partners.
+  
 
 Args:
-  name: string, Identifier. The resource name of the user list global license. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A user list global license. This feature is only available to data partners.
-  "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only.
-    { # A user list license pricing.
-      "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
-      "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`.
-      "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
-      "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
-      "endTime": "A String", # Optional. End time of the pricing.
-      "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap.
-      "pricingActive": True or False, # Output only. Whether this pricing is active.
-      "pricingId": "A String", # Output only. The ID of this pricing.
-      "startTime": "A String", # Output only. Start time of the pricing.
+{
+  "historicalPricings": [
+    {
+      "buyerApprovalState": "A String",
+      "costMicros": "A String",
+      "costType": "A String",
+      "currencyCode": "A String",
+      "endTime": "A String",
+      "maxCostMicros": "A String",
+      "pricingActive": True or False,
+      "pricingId": "A String",
+      "startTime": "A String",
     },
   ],
-  "licenseType": "A String", # Immutable. Product type of client customer which the user list is being licensed to.
-  "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call
-    "clickCount": "A String", # Output only. The number of clicks for the user list license.
-    "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.
-    "impressionCount": "A String", # Output only. The number of impressions for the user list license.
-    "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros.
-    "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.
+  "licenseType": "A String",
+  "metrics": {
+    "clickCount": "A String",
+    "endDate": "A String",
+    "impressionCount": "A String",
+    "revenueUsdMicros": "A String",
+    "startDate": "A String",
   },
-  "name": "A String", # Identifier. The resource name of the user list global license.
-  "pricing": { # A user list license pricing. # Optional. UserListGlobalLicense pricing.
-    "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only.
-    "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`.
-    "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.
-    "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
-    "endTime": "A String", # Optional. End time of the pricing.
-    "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap.
-    "pricingActive": True or False, # Output only. Whether this pricing is active.
-    "pricingId": "A String", # Output only. The ID of this pricing.
-    "startTime": "A String", # Output only. Start time of the pricing.
+  "name": "A String",
+  "pricing": {
+    "buyerApprovalState": "A String",
+    "costMicros": "A String",
+    "costType": "A String",
+    "currencyCode": "A String",
+    "endTime": "A String",
+    "maxCostMicros": "A String",
+    "pricingActive": True or False,
+    "pricingId": "A String",
+    "startTime": "A String",
   },
-  "status": "A String", # Optional. Status of UserListGlobalLicense - ENABLED or DISABLED.
-  "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only.
-  "userListId": "A String", # Immutable. ID of the user list being licensed.
+  "status": "A String",
+  "userListDisplayName": "A String",
+  "userListId": "A String",
 }
 
-  updateMask: string, Optional. The list of fields to update. The special character `*` is not supported and an `INVALID_UPDATE_MASK` error will be thrown if used.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -386,43 +386,43 @@ 

Method Details

Returns: An object of the form: - { # A user list global license. This feature is only available to data partners. - "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. - { # A user list license pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + { + "historicalPricings": [ + { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, ], - "licenseType": "A String", # Immutable. Product type of client customer which the user list is being licensed to. - "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call - "clickCount": "A String", # Output only. The number of clicks for the user list license. - "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. - "impressionCount": "A String", # Output only. The number of impressions for the user list license. - "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. - "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "licenseType": "A String", + "metrics": { + "clickCount": "A String", + "endDate": "A String", + "impressionCount": "A String", + "revenueUsdMicros": "A String", + "startDate": "A String", }, - "name": "A String", # Identifier. The resource name of the user list global license. - "pricing": { # A user list license pricing. # Optional. UserListGlobalLicense pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + "name": "A String", + "pricing": { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, - "status": "A String", # Optional. Status of UserListGlobalLicense - ENABLED or DISABLED. - "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. - "userListId": "A String", # Immutable. ID of the user list being licensed. + "status": "A String", + "userListDisplayName": "A String", + "userListId": "A String", }
diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.html index 6f96d1db1c..b96c2bdf9c 100644 --- a/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.html +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Lists all customer info for a user list global license. This feature is only available to data partners.

+

list_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -91,13 +91,13 @@

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all customer info for a user list global license. This feature is only available to data partners.
+  
 
 Args:
-  parent: string, Required. The global license whose customer info are being queried. Should be in the format `accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}`. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, `accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-`) (required)
-  filter: string, Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(user_list_id, 123, 456)` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`
-  pageSize: integer, Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses 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 `ListUserListDirectLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  filter: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -106,49 +106,49 @@ 

Method Details

Returns: An object of the form: - { # Response from the ListUserListGlobalLicensesCustomerInfoRequest. - "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. - "userListGlobalLicenseCustomerInfos": [ # The customer information for the given license in the request. - { # Information about a customer of a user list global license. This will automatically be created by the system when a customer purchases a global license. - "clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. - "clientAccountId": "A String", # Output only. ID of client customer which the user list is being licensed to. - "clientAccountType": "A String", # Output only. Product type of client customer which the user list is being licensed to. - "historicalPricings": [ # Output only. Pricing history of this user list license. - { # A user list license pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + { + "nextPageToken": "A String", + "userListGlobalLicenseCustomerInfos": [ + { + "clientAccountDisplayName": "A String", + "clientAccountId": "A String", + "clientAccountType": "A String", + "historicalPricings": [ + { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, ], - "licenseType": "A String", # Output only. Product type of client customer which the user list is being licensed to. - "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is only populated if the start and end dates are set in the ListUserListGlobalLicenseCustomerInfos call. - "clickCount": "A String", # Output only. The number of clicks for the user list license. - "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. - "impressionCount": "A String", # Output only. The number of impressions for the user list license. - "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. - "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "licenseType": "A String", + "metrics": { + "clickCount": "A String", + "endDate": "A String", + "impressionCount": "A String", + "revenueUsdMicros": "A String", + "startDate": "A String", }, - "name": "A String", # Identifier. The resource name of the user list global license customer. - "pricing": { # A user list license pricing. # Output only. UserListDirectLicense pricing. - "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. - "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. - "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. - "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. - "endTime": "A String", # Optional. End time of the pricing. - "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. - "pricingActive": True or False, # Output only. Whether this pricing is active. - "pricingId": "A String", # Output only. The ID of this pricing. - "startTime": "A String", # Output only. Start time of the pricing. + "name": "A String", + "pricing": { + "buyerApprovalState": "A String", + "costMicros": "A String", + "costType": "A String", + "currencyCode": "A String", + "endTime": "A String", + "maxCostMicros": "A String", + "pricingActive": True or False, + "pricingId": "A String", + "startTime": "A String", }, - "status": "A String", # Output only. Status of UserListDirectLicense - ENABLED or DISABLED. - "userListDisplayName": "A String", # Output only. Name of the user list being licensed. - "userListId": "A String", # Output only. ID of the user list being licensed. + "status": "A String", + "userListDisplayName": "A String", + "userListId": "A String", }, ], }
diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html index 2b3a4f97b7..c09789df94 100644 --- a/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

create(parent, body=None, validateOnly=None, x__xgafv=None)

-

Creates a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`

+

delete(name, validateOnly=None, x__xgafv=None)

-

Deletes a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`

+

get(name, x__xgafv=None)

-

Gets a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`

+

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

-

Lists UserLists. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`

+

list_next(previous_request, previous_response)

Retrieves the next page of results.

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

-

Updates a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`

+

Method Details

close() @@ -103,70 +103,70 @@

Method Details

create(parent, body=None, validateOnly=None, x__xgafv=None) -
Creates a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
+  
 
 Args:
-  parent: string, Required. The parent account where this user list will be created. Format: accountTypes/{account_type}/accounts/{account} (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A user list resource.
-  "accessReason": "A String", # Output only. The reason this account has been granted access to the list.
-  "accountAccessStatus": "A String", # Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to `ENABLED`. Later the user list owner can decide to revoke the share and make it `DISABLED`.
-  "closingReason": "A String", # Output only. The reason why this user list membership status is closed.
-  "description": "A String", # Optional. A description of the user list.
-  "displayName": "A String", # Required. The display name of the user list.
-  "id": "A String", # Output only. The unique ID of the user list.
-  "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data.
-    "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`.
-      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data
-      "matchRatePercentage": 42, # Output only. Match rate for customer match user lists.
+{
+  "accessReason": "A String",
+  "accountAccessStatus": "A String",
+  "closingReason": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "id": "A String",
+  "ingestedUserListInfo": {
+    "contactIdInfo": {
+      "dataSourceType": "A String",
+      "matchRatePercentage": 42,
     },
-    "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`.
-      "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.
-      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data.
-      "keySpace": "A String", # Required. Immutable. The key space of mobile IDs.
+    "mobileIdInfo": {
+      "appId": "A String",
+      "dataSourceType": "A String",
+      "keySpace": "A String",
     },
-    "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.
-      "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
-      "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
-      "matchRatePercentage": 42, # Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
-      "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.
-      "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
+    "pairIdInfo": {
+      "advertiserIdentifierCount": "A String",
+      "cleanRoomIdentifier": "A String",
+      "matchRatePercentage": 42,
+      "publisherId": "A String",
+      "publisherName": "A String",
     },
-    "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners.
-      "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.
-      "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience.
+    "partnerAudienceInfo": {
+      "commercePartner": "A String",
+      "partnerAudienceSource": "A String",
     },
-    "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`.
-      "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched).
-      "syncStatus": "A String", # Output only. Sync status of the user list.
+    "pseudonymousIdInfo": {
+      "billableRecordCount": "A String",
+      "syncStatus": "A String",
     },
-    "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list.
+    "uploadKeyTypes": [
       "A String",
     ],
-    "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`.
-      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data.
+    "userIdInfo": {
+      "dataSourceType": "A String",
     },
   },
-  "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
-  "membershipDuration": "A String", # Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error.
-  "membershipStatus": "A String", # Optional. Membership status of this user list.
-  "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
-  "readOnly": True or False, # Output only. An option that indicates if a user may edit a list.
-  "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks.
-    "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network.
-    "gmailMembersCount": "A String", # Output only. Estimated number of members in this user list on Gmail.
-    "searchNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns.
-    "youtubeMembersCount": "A String", # Output only. Estimated number of members in this user list on YouTube.
+  "integrationCode": "A String",
+  "membershipDuration": "A String",
+  "membershipStatus": "A String",
+  "name": "A String",
+  "readOnly": True or False,
+  "sizeInfo": {
+    "displayNetworkMembersCount": "A String",
+    "gmailMembersCount": "A String",
+    "searchNetworkMembersCount": "A String",
+    "youtubeMembersCount": "A String",
   },
-  "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks.
-    "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network.
-    "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network.
+  "targetNetworkInfo": {
+    "eligibleForDisplay": True or False,
+    "eligibleForSearch": True or False,
   },
 }
 
-  validateOnly: boolean, Optional. If true, the request is validated but not executed.
+  validateOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -175,70 +175,70 @@ 

Method Details

Returns: An object of the form: - { # A user list resource. - "accessReason": "A String", # Output only. The reason this account has been granted access to the list. - "accountAccessStatus": "A String", # Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to `ENABLED`. Later the user list owner can decide to revoke the share and make it `DISABLED`. - "closingReason": "A String", # Output only. The reason why this user list membership status is closed. - "description": "A String", # Optional. A description of the user list. - "displayName": "A String", # Required. The display name of the user list. - "id": "A String", # Output only. The unique ID of the user list. - "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data. - "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`. - "dataSourceType": "A String", # Optional. Immutable. Source of the upload data - "matchRatePercentage": 42, # Output only. Match rate for customer match user lists. + { + "accessReason": "A String", + "accountAccessStatus": "A String", + "closingReason": "A String", + "description": "A String", + "displayName": "A String", + "id": "A String", + "ingestedUserListInfo": { + "contactIdInfo": { + "dataSourceType": "A String", + "matchRatePercentage": 42, }, - "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`. - "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected. - "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. - "keySpace": "A String", # Required. Immutable. The key space of mobile IDs. + "mobileIdInfo": { + "appId": "A String", + "dataSourceType": "A String", + "keySpace": "A String", }, - "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. - "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. - "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. - "matchRatePercentage": 42, # Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. - "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. - "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. + "pairIdInfo": { + "advertiserIdentifierCount": "A String", + "cleanRoomIdentifier": "A String", + "matchRatePercentage": 42, + "publisherId": "A String", + "publisherName": "A String", }, - "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners. - "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`. - "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience. + "partnerAudienceInfo": { + "commercePartner": "A String", + "partnerAudienceSource": "A String", }, - "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`. - "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched). - "syncStatus": "A String", # Output only. Sync status of the user list. + "pseudonymousIdInfo": { + "billableRecordCount": "A String", + "syncStatus": "A String", }, - "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list. + "uploadKeyTypes": [ "A String", ], - "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`. - "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. + "userIdInfo": { + "dataSourceType": "A String", }, }, - "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems. - "membershipDuration": "A String", # Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error. - "membershipStatus": "A String", # Optional. Membership status of this user list. - "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} - "readOnly": True or False, # Output only. An option that indicates if a user may edit a list. - "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks. - "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network. - "gmailMembersCount": "A String", # Output only. Estimated number of members in this user list on Gmail. - "searchNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns. - "youtubeMembersCount": "A String", # Output only. Estimated number of members in this user list on YouTube. + "integrationCode": "A String", + "membershipDuration": "A String", + "membershipStatus": "A String", + "name": "A String", + "readOnly": True or False, + "sizeInfo": { + "displayNetworkMembersCount": "A String", + "gmailMembersCount": "A String", + "searchNetworkMembersCount": "A String", + "youtubeMembersCount": "A String", }, - "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks. - "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network. - "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network. + "targetNetworkInfo": { + "eligibleForDisplay": True or False, + "eligibleForSearch": True or False, }, }
delete(name, validateOnly=None, x__xgafv=None) -
Deletes a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
+  
 
 Args:
-  name: string, Required. The name of the user list to delete. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} (required)
-  validateOnly: boolean, Optional. If true, the request is validated but not executed.
+  name: string, A parameter (required)
+  validateOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -247,16 +247,16 @@ 

Method Details

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 UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
+  
 
 Args:
-  name: string, Required. The resource name of the UserList to retrieve. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -265,72 +265,72 @@ 

Method Details

Returns: An object of the form: - { # A user list resource. - "accessReason": "A String", # Output only. The reason this account has been granted access to the list. - "accountAccessStatus": "A String", # Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to `ENABLED`. Later the user list owner can decide to revoke the share and make it `DISABLED`. - "closingReason": "A String", # Output only. The reason why this user list membership status is closed. - "description": "A String", # Optional. A description of the user list. - "displayName": "A String", # Required. The display name of the user list. - "id": "A String", # Output only. The unique ID of the user list. - "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data. - "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`. - "dataSourceType": "A String", # Optional. Immutable. Source of the upload data - "matchRatePercentage": 42, # Output only. Match rate for customer match user lists. + { + "accessReason": "A String", + "accountAccessStatus": "A String", + "closingReason": "A String", + "description": "A String", + "displayName": "A String", + "id": "A String", + "ingestedUserListInfo": { + "contactIdInfo": { + "dataSourceType": "A String", + "matchRatePercentage": 42, }, - "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`. - "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected. - "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. - "keySpace": "A String", # Required. Immutable. The key space of mobile IDs. + "mobileIdInfo": { + "appId": "A String", + "dataSourceType": "A String", + "keySpace": "A String", }, - "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. - "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. - "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. - "matchRatePercentage": 42, # Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. - "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. - "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. + "pairIdInfo": { + "advertiserIdentifierCount": "A String", + "cleanRoomIdentifier": "A String", + "matchRatePercentage": 42, + "publisherId": "A String", + "publisherName": "A String", }, - "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners. - "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`. - "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience. + "partnerAudienceInfo": { + "commercePartner": "A String", + "partnerAudienceSource": "A String", }, - "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`. - "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched). - "syncStatus": "A String", # Output only. Sync status of the user list. + "pseudonymousIdInfo": { + "billableRecordCount": "A String", + "syncStatus": "A String", }, - "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list. + "uploadKeyTypes": [ "A String", ], - "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`. - "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. + "userIdInfo": { + "dataSourceType": "A String", }, }, - "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems. - "membershipDuration": "A String", # Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error. - "membershipStatus": "A String", # Optional. Membership status of this user list. - "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} - "readOnly": True or False, # Output only. An option that indicates if a user may edit a list. - "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks. - "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network. - "gmailMembersCount": "A String", # Output only. Estimated number of members in this user list on Gmail. - "searchNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns. - "youtubeMembersCount": "A String", # Output only. Estimated number of members in this user list on YouTube. + "integrationCode": "A String", + "membershipDuration": "A String", + "membershipStatus": "A String", + "name": "A String", + "readOnly": True or False, + "sizeInfo": { + "displayNetworkMembersCount": "A String", + "gmailMembersCount": "A String", + "searchNetworkMembersCount": "A String", + "youtubeMembersCount": "A String", }, - "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks. - "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network. - "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network. + "targetNetworkInfo": { + "eligibleForDisplay": True or False, + "eligibleForSearch": True or False, }, }
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists UserLists. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
+  
 
 Args:
-  parent: string, Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account} (required)
-  filter: string, Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `display_name = "list 1"`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` - `:` (has) **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(display_name, "name1", "name2")` Supported fields: - `id` - `display_name` - `description` - `membership_status` - `integration_code` - `access_reason` - `ingested_user_list_info.upload_key_types`
-  pageSize: integer, Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists 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 `ListUserLists` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLists` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  filter: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -339,62 +339,62 @@ 

Method Details

Returns: An object of the form: - { # Response message for ListUserLists. - "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. - "userLists": [ # The user lists from the specified account. - { # A user list resource. - "accessReason": "A String", # Output only. The reason this account has been granted access to the list. - "accountAccessStatus": "A String", # Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to `ENABLED`. Later the user list owner can decide to revoke the share and make it `DISABLED`. - "closingReason": "A String", # Output only. The reason why this user list membership status is closed. - "description": "A String", # Optional. A description of the user list. - "displayName": "A String", # Required. The display name of the user list. - "id": "A String", # Output only. The unique ID of the user list. - "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data. - "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`. - "dataSourceType": "A String", # Optional. Immutable. Source of the upload data - "matchRatePercentage": 42, # Output only. Match rate for customer match user lists. + { + "nextPageToken": "A String", + "userLists": [ + { + "accessReason": "A String", + "accountAccessStatus": "A String", + "closingReason": "A String", + "description": "A String", + "displayName": "A String", + "id": "A String", + "ingestedUserListInfo": { + "contactIdInfo": { + "dataSourceType": "A String", + "matchRatePercentage": 42, }, - "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`. - "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected. - "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. - "keySpace": "A String", # Required. Immutable. The key space of mobile IDs. + "mobileIdInfo": { + "appId": "A String", + "dataSourceType": "A String", + "keySpace": "A String", }, - "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. - "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. - "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. - "matchRatePercentage": 42, # Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. - "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. - "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. + "pairIdInfo": { + "advertiserIdentifierCount": "A String", + "cleanRoomIdentifier": "A String", + "matchRatePercentage": 42, + "publisherId": "A String", + "publisherName": "A String", }, - "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners. - "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`. - "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience. + "partnerAudienceInfo": { + "commercePartner": "A String", + "partnerAudienceSource": "A String", }, - "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`. - "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched). - "syncStatus": "A String", # Output only. Sync status of the user list. + "pseudonymousIdInfo": { + "billableRecordCount": "A String", + "syncStatus": "A String", }, - "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list. + "uploadKeyTypes": [ "A String", ], - "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`. - "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. + "userIdInfo": { + "dataSourceType": "A String", }, }, - "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems. - "membershipDuration": "A String", # Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error. - "membershipStatus": "A String", # Optional. Membership status of this user list. - "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} - "readOnly": True or False, # Output only. An option that indicates if a user may edit a list. - "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks. - "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network. - "gmailMembersCount": "A String", # Output only. Estimated number of members in this user list on Gmail. - "searchNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns. - "youtubeMembersCount": "A String", # Output only. Estimated number of members in this user list on YouTube. + "integrationCode": "A String", + "membershipDuration": "A String", + "membershipStatus": "A String", + "name": "A String", + "readOnly": True or False, + "sizeInfo": { + "displayNetworkMembersCount": "A String", + "gmailMembersCount": "A String", + "searchNetworkMembersCount": "A String", + "youtubeMembersCount": "A String", }, - "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks. - "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network. - "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network. + "targetNetworkInfo": { + "eligibleForDisplay": True or False, + "eligibleForSearch": True or False, }, }, ], @@ -417,71 +417,71 @@

Method Details

patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None) -
Updates a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
+  
 
 Args:
-  name: string, Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A user list resource.
-  "accessReason": "A String", # Output only. The reason this account has been granted access to the list.
-  "accountAccessStatus": "A String", # Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to `ENABLED`. Later the user list owner can decide to revoke the share and make it `DISABLED`.
-  "closingReason": "A String", # Output only. The reason why this user list membership status is closed.
-  "description": "A String", # Optional. A description of the user list.
-  "displayName": "A String", # Required. The display name of the user list.
-  "id": "A String", # Output only. The unique ID of the user list.
-  "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data.
-    "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`.
-      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data
-      "matchRatePercentage": 42, # Output only. Match rate for customer match user lists.
+{
+  "accessReason": "A String",
+  "accountAccessStatus": "A String",
+  "closingReason": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "id": "A String",
+  "ingestedUserListInfo": {
+    "contactIdInfo": {
+      "dataSourceType": "A String",
+      "matchRatePercentage": 42,
     },
-    "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`.
-      "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.
-      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data.
-      "keySpace": "A String", # Required. Immutable. The key space of mobile IDs.
+    "mobileIdInfo": {
+      "appId": "A String",
+      "dataSourceType": "A String",
+      "keySpace": "A String",
     },
-    "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.
-      "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
-      "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
-      "matchRatePercentage": 42, # Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
-      "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.
-      "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
+    "pairIdInfo": {
+      "advertiserIdentifierCount": "A String",
+      "cleanRoomIdentifier": "A String",
+      "matchRatePercentage": 42,
+      "publisherId": "A String",
+      "publisherName": "A String",
     },
-    "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners.
-      "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.
-      "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience.
+    "partnerAudienceInfo": {
+      "commercePartner": "A String",
+      "partnerAudienceSource": "A String",
     },
-    "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`.
-      "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched).
-      "syncStatus": "A String", # Output only. Sync status of the user list.
+    "pseudonymousIdInfo": {
+      "billableRecordCount": "A String",
+      "syncStatus": "A String",
     },
-    "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list.
+    "uploadKeyTypes": [
       "A String",
     ],
-    "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`.
-      "dataSourceType": "A String", # Optional. Immutable. Source of the upload data.
+    "userIdInfo": {
+      "dataSourceType": "A String",
     },
   },
-  "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
-  "membershipDuration": "A String", # Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error.
-  "membershipStatus": "A String", # Optional. Membership status of this user list.
-  "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
-  "readOnly": True or False, # Output only. An option that indicates if a user may edit a list.
-  "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks.
-    "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network.
-    "gmailMembersCount": "A String", # Output only. Estimated number of members in this user list on Gmail.
-    "searchNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns.
-    "youtubeMembersCount": "A String", # Output only. Estimated number of members in this user list on YouTube.
+  "integrationCode": "A String",
+  "membershipDuration": "A String",
+  "membershipStatus": "A String",
+  "name": "A String",
+  "readOnly": True or False,
+  "sizeInfo": {
+    "displayNetworkMembersCount": "A String",
+    "gmailMembersCount": "A String",
+    "searchNetworkMembersCount": "A String",
+    "youtubeMembersCount": "A String",
   },
-  "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks.
-    "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network.
-    "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network.
+  "targetNetworkInfo": {
+    "eligibleForDisplay": True or False,
+    "eligibleForSearch": True or False,
   },
 }
 
-  updateMask: string, Optional. The list of fields to update.
-  validateOnly: boolean, Optional. If true, the request is validated but not executed.
+  updateMask: string, A parameter
+  validateOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -490,59 +490,59 @@ 

Method Details

Returns: An object of the form: - { # A user list resource. - "accessReason": "A String", # Output only. The reason this account has been granted access to the list. - "accountAccessStatus": "A String", # Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to `ENABLED`. Later the user list owner can decide to revoke the share and make it `DISABLED`. - "closingReason": "A String", # Output only. The reason why this user list membership status is closed. - "description": "A String", # Optional. A description of the user list. - "displayName": "A String", # Required. The display name of the user list. - "id": "A String", # Output only. The unique ID of the user list. - "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data. - "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`. - "dataSourceType": "A String", # Optional. Immutable. Source of the upload data - "matchRatePercentage": 42, # Output only. Match rate for customer match user lists. + { + "accessReason": "A String", + "accountAccessStatus": "A String", + "closingReason": "A String", + "description": "A String", + "displayName": "A String", + "id": "A String", + "ingestedUserListInfo": { + "contactIdInfo": { + "dataSourceType": "A String", + "matchRatePercentage": 42, }, - "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`. - "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected. - "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. - "keySpace": "A String", # Required. Immutable. The key space of mobile IDs. + "mobileIdInfo": { + "appId": "A String", + "dataSourceType": "A String", + "keySpace": "A String", }, - "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. - "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. - "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. - "matchRatePercentage": 42, # Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. - "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. - "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. + "pairIdInfo": { + "advertiserIdentifierCount": "A String", + "cleanRoomIdentifier": "A String", + "matchRatePercentage": 42, + "publisherId": "A String", + "publisherName": "A String", }, - "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners. - "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`. - "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience. + "partnerAudienceInfo": { + "commercePartner": "A String", + "partnerAudienceSource": "A String", }, - "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`. - "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched). - "syncStatus": "A String", # Output only. Sync status of the user list. + "pseudonymousIdInfo": { + "billableRecordCount": "A String", + "syncStatus": "A String", }, - "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list. + "uploadKeyTypes": [ "A String", ], - "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`. - "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. + "userIdInfo": { + "dataSourceType": "A String", }, }, - "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems. - "membershipDuration": "A String", # Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error. - "membershipStatus": "A String", # Optional. Membership status of this user list. - "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} - "readOnly": True or False, # Output only. An option that indicates if a user may edit a list. - "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks. - "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network. - "gmailMembersCount": "A String", # Output only. Estimated number of members in this user list on Gmail. - "searchNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns. - "youtubeMembersCount": "A String", # Output only. Estimated number of members in this user list on YouTube. + "integrationCode": "A String", + "membershipDuration": "A String", + "membershipStatus": "A String", + "name": "A String", + "readOnly": True or False, + "sizeInfo": { + "displayNetworkMembersCount": "A String", + "gmailMembersCount": "A String", + "searchNetworkMembersCount": "A String", + "youtubeMembersCount": "A String", }, - "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks. - "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network. - "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network. + "targetNetworkInfo": { + "eligibleForDisplay": True or False, + "eligibleForSearch": True or False, }, }
diff --git a/docs/dyn/datamanager_v1.adEvents.html b/docs/dyn/datamanager_v1.adEvents.html index 7d06050177..61b077766a 100644 --- a/docs/dyn/datamanager_v1.adEvents.html +++ b/docs/dyn/datamanager_v1.adEvents.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

ingest(body=None, x__xgafv=None)

-

Uploads a list of AdEvent resources to Google Analytics. This feature is only available to accounts on an allowlist.

+

Method Details

close() @@ -88,106 +88,107 @@

Method Details

ingest(body=None, x__xgafv=None) -
Uploads a list of AdEvent resources to Google Analytics. This feature is only available to accounts on an allowlist.
+  
 
 Args:
   body: object, The request body.
     The object takes the form of:
 
-{ # Request to upload ad events.
-  "adEvents": [ # Required. Required (at least 1). A list of ad events.
-    { # An ad event.
-      "adFormat": "A String", # Enum value for ad format.
-      "adFormatString": "A String", # String value for ad format.
-      "adGroupId": "A String", # Optional. The ID of the associated ad group.
-      "adHeight": 42, # Optional. The height of the ad in pixels.
-      "adId": "A String", # Optional. The ID of the associated ad within the group.
-      "adPlacement": "A String", # Enum value for ad placement.
-      "adPlacementString": "A String", # String value for ad placement.
-      "adType": "A String", # Enum value for ad type.
-      "adTypeString": "A String", # String value for ad type.
-      "adWidth": 42, # Optional. The width of the ad in pixels.
-      "advertiserId": "A String", # Required. The ID of the advertiser for the ad event. This must match the ID sent in the linking flow.
-      "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. # 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. Required when used in an AdEvent.
-        "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.
-        "operatingSystemVersion": "A String", # Optional. The version of the operating system or platform.
-        "screenHeight": 42, # Optional. The height of the screen in pixels.
-        "screenWidth": 42, # Optional. The width of the screen in pixels.
-        "userAgent": "A String", # Optional. The user-agent string of the device for the given context.
+{
+  "adEvents": [
+    {
+      "adFormat": "A String",
+      "adFormatString": "A String",
+      "adGroupId": "A String",
+      "adHeight": 42,
+      "adId": "A String",
+      "adPlacement": "A String",
+      "adPlacementString": "A String",
+      "adType": "A String",
+      "adTypeString": "A String",
+      "adWidth": 42,
+      "advertiserId": "A String",
+      "attributionHint": "A String",
+      "campaignId": "A String",
+      "campaignName": "A String",
+      "deviceInfo": {
+        "brand": "A String",
+        "browser": "A String",
+        "browserVersion": "A String",
+        "category": "A String",
+        "ipAddress": "A String",
+        "languageCode": "A String",
+        "model": "A String",
+        "operatingSystem": "A String",
+        "operatingSystemVersion": "A String",
+        "screenHeight": 42,
+        "screenWidth": 42,
+        "userAgent": "A String",
       },
-      "eventId": "A String", # 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.
-      "eventSubtype": "A String", # Enum value for event subtype.
-      "eventSubtypeString": "A String", # String value for event subtype.
-      "eventType": "A String", # Required. The type of the event.
-      "measurementAllowed": True or False, # Optional. Represents if the row is allowed to be used for measurement purposes, as governed by applicable privacy laws within regional jurisdiction.
-      "medium": "A String", # Required. The medium of the ad, akin to the Google Analytics medium.
-      "mobileDeviceId": "A String", # Optional. The device ID of the device that the ad was served to.
-      "platform": "A String", # Enum value for platform.
-      "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", # 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.
-      "timestamp": "A String", # Required. The time the event occurred.
-      "userData": { # Data that identifies the user. At least one identifier is required. # Optional. Multiple pieces of user-provided data, representing the user the event is associated with. It is possible to provide multiple instances of the same type of data (e.g. email address). The more data provided, the more likely a match will be found.
-        "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.
-              "regionCode": "A String", # Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.
+      "eventId": "A String",
+      "eventSubtype": "A String",
+      "eventSubtypeString": "A String",
+      "eventType": "A String",
+      "ipAddress": "A String",
+      "measurementAllowed": True or False,
+      "medium": "A String",
+      "mobileDeviceId": "A String",
+      "platform": "A String",
+      "platformString": "A String",
+      "platformType": "A String",
+      "platformTypeString": "A String",
+      "regionCode": "A String",
+      "source": "A String",
+      "targetingType": "A String",
+      "targetingTypeString": "A String",
+      "timestamp": "A String",
+      "userData": {
+        "userIdentifiers": [
+          {
+            "address": {
+              "addressLine": "A String",
+              "administrativeArea": "A String",
+              "city": "A String",
+              "familyName": "A String",
+              "givenName": "A String",
+              "postalCode": "A String",
+              "regionCode": "A String",
             },
-            "emailAddress": "A String", # Hashed email address using SHA-256 hash function after normalization.
-            "phoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard).
+            "emailAddress": "A String",
+            "phoneNumber": "A String",
           },
         ],
       },
-      "viewabilityInfo": { # Details of the viewability of the ad served. # Required. Details of the viewability of the ad served.
-        "mediaDuration": "A String", # Optional. The duration of the ad media.
-        "mediaQuartile": "A String", # Optional. The amount of the media that was played as discrete quartiles.
-        "mediaSkippable": True or False, # Optional. Whether the ad media was skippable or not.
-        "mediaVolumePercent": 42, # Optional. The numerical percent (0-100) of the volume of the media playback.
-        "playbackDuration": "A String", # Optional. The duration of playback of the ad media, regardless of whether it was viewable or not.
-        "viewType": "A String", # Required. The type of the event.
-        "viewableDuration": "A String", # Optional. The amount of time the ad was viewable for.
-        "viewablePercent": 42, # Optional. The numerical percent (0-100) of the pixels that were viewable.
+      "viewabilityInfo": {
+        "mediaDuration": "A String",
+        "mediaQuartile": "A String",
+        "mediaSkippable": True or False,
+        "mediaVolumePercent": 42,
+        "playbackDuration": "A String",
+        "viewType": "A String",
+        "viewableDuration": "A String",
+        "viewablePercent": 42,
       },
     },
   ],
-  "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}`
-      "keyType": "A String", # Required. The type of algorithm used to encrypt the data.
-      "roleArn": "A String", # Required. The Amazon Resource Name of the IAM Role to assume for KMS decryption access. Should be in the format of `arn:{partition}:iam::{account_id}:role/{role_name}`
+  "encryptionInfo": {
+    "awsWrappedKeyInfo": {
+      "encryptedDek": "A String",
+      "kekUri": "A String",
+      "keyType": "A String",
+      "roleArn": "A String",
     },
-    "coordinatorKeyInfo": { # Information about the coordinator key. # Key information for the chosen coordinator key. This is not supported for the IngestEvents, IngestAudienceMembers, and RemoveAudienceMembers methods.
-      "keyId": "A String", # Required. The ID of the chosen coordinator key.
+    "coordinatorKeyInfo": {
+      "keyId": "A String",
     },
-    "gcpWrappedKeyInfo": { # Information about the Google Cloud Platform wrapped key. # Google Cloud Platform wrapped key information.
-      "encryptedDek": "A String", # Required. The base64 encoded encrypted data encryption key.
-      "kekUri": "A String", # Required. Google Cloud Platform [Cloud Key Management Service resource ID](//cloud.google.com/kms/docs/getting-resource-ids). Should be in the format of `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}` or `gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}`
-      "keyType": "A String", # Required. The type of algorithm used to encrypt the data.
-      "wipProvider": "A String", # Required. The [Workload Identity](//cloud.google.com/iam/docs/workload-identity-federation) pool provider required to use KEK.
+    "gcpWrappedKeyInfo": {
+      "encryptedDek": "A String",
+      "kekUri": "A String",
+      "keyType": "A String",
+      "wipProvider": "A String",
     },
   },
-  "validateOnly": True or False, # Optional. If true, the request is validated, but not executed.
+  "validateOnly": True or False,
 }
 
   x__xgafv: string, V1 error format.
@@ -198,7 +199,7 @@ 

Method Details

Returns: An object of the form: - { # Response from an ad event ingestion operation. + { }
diff --git a/docs/dyn/datamanager_v1.audienceMembers.html b/docs/dyn/datamanager_v1.audienceMembers.html index d2a8addd6a..e5390e10a6 100644 --- a/docs/dyn/datamanager_v1.audienceMembers.html +++ b/docs/dyn/datamanager_v1.audienceMembers.html @@ -79,13 +79,13 @@

Instance Methods

Close httplib2 connections.

ingest(body=None, x__xgafv=None)

-

Uploads a list of AudienceMember resources to the provided Destination.

+

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() @@ -94,142 +94,142 @@

Method Details

ingest(body=None, x__xgafv=None) -
Uploads a list of AudienceMember resources to the provided Destination.
+  
 
 Args:
   body: object, The request body.
     The object takes the form of:
 
-{ # Request to upload audience members to the provided destinations. Returns an IngestAudienceMembersResponse.
-  "audienceMembers": [ # Required. The list of users to send to the specified destinations. At most 10000 AudienceMember resources can be sent in a single request.
-    { # The audience member to be operated on.
-      "compositeData": { # Composite data holding identifiers and associated data for a user. At least one of `user_data` or `ip_data` is required. # Group of multiple identifier types.
-        "ipData": [ # Optional. IP address data representing customer interaction used to build the audience.
-          { # IP address information for a user. We recommend including observe_start_time and observe_end_time to help improve Customer Match match rates.
-            "ipAddress": "A String", # Required. IP address captured at the time of customer interaction. Accepts standard string formats for both IPv4 and IPv6.
-            "observeEndTime": "A String", # Optional. Last recorded interaction time from this IP address in a session.
-            "observeStartTime": "A String", # Optional. First recorded interaction time from this IP address in a session.
+{
+  "audienceMembers": [
+    {
+      "compositeData": {
+        "ipData": [
+          {
+            "ipAddress": "A String",
+            "observeEndTime": "A String",
+            "observeStartTime": "A String",
           },
         ],
-        "userData": { # Data that identifies the user. At least one identifier is required. # Optional. User-provided data that identifies the user.
-          "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.
-                "regionCode": "A String", # Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.
+        "userData": {
+          "userIdentifiers": [
+            {
+              "address": {
+                "addressLine": "A String",
+                "administrativeArea": "A String",
+                "city": "A String",
+                "familyName": "A String",
+                "givenName": "A String",
+                "postalCode": "A String",
+                "regionCode": "A String",
               },
-              "emailAddress": "A String", # Hashed email address using SHA-256 hash function after normalization.
-              "phoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard).
+              "emailAddress": "A String",
+              "phoneNumber": "A String",
             },
           ],
         },
       },
-      "consent": { # [Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user. # Optional. The consent setting for the user.
-        "adPersonalization": "A String", # Optional. Represents if the user consents to ad personalization.
-        "adUserData": "A String", # Optional. Represents if the user consents to ad user data.
+      "consent": {
+        "adPersonalization": "A String",
+        "adUserData": "A String",
       },
-      "destinationReferences": [ # Optional. Defines which Destination to send the audience member to.
+      "destinationReferences": [
         "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.
+      "googleUserIdData": {
+        "googleUserIds": [
           "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 (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.
+      "mobileData": {
+        "mobileIds": [
           "A String",
         ],
       },
-      "pairData": { # [PAIR](//support.google.com/admanager/answer/15067908) IDs for the audience. At least one PAIR ID is required. This feature is only available to data partners. # [Publisher Advertiser Identity Reconciliation (PAIR) IDs](//support.google.com/admanager/answer/15067908). This feature is only available to data partners.
-        "pairIds": [ # Required. Cleanroom-provided PII data, hashed with SHA256, and encrypted with an EC commutative cipher using publisher key for the [PAIR]((//support.google.com/admanager/answer/15067908)) user list. At most 10 `pairIds` can be provided in a single AudienceMember.
+      "pairData": {
+        "pairIds": [
           "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.
+      "partnerProvidedIdData": {
+        "partnerProvidedIds": [
           "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.
+      "ppidData": {
+        "ppids": [
           "A String",
         ],
       },
-      "userData": { # Data that identifies the user. At least one identifier is required. # User-provided data that identifies the user.
-        "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.
-              "regionCode": "A String", # Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.
+      "userData": {
+        "userIdentifiers": [
+          {
+            "address": {
+              "addressLine": "A String",
+              "administrativeArea": "A String",
+              "city": "A String",
+              "familyName": "A String",
+              "givenName": "A String",
+              "postalCode": "A String",
+              "regionCode": "A String",
             },
-            "emailAddress": "A String", # Hashed email address using SHA-256 hash function after normalization.
-            "phoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard).
+            "emailAddress": "A String",
+            "phoneNumber": "A String",
           },
         ],
       },
-      "userIdData": { # User id data holding the user id. # Data related to unique identifiers for a user, as defined by the advertiser.
-        "userId": "A String", # Required. A unique identifier for a user, as defined by the advertiser.
+      "userIdData": {
+        "userId": "A String",
       },
     },
   ],
-  "consent": { # [Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user. # Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each AudienceMember.
-    "adPersonalization": "A String", # Optional. Represents if the user consents to ad personalization.
-    "adUserData": "A String", # Optional. Represents if the user consents to ad user data.
+  "consent": {
+    "adPersonalization": "A String",
+    "adUserData": "A String",
   },
-  "destinations": [ # Required. The list of destinations to send the audience members to.
-    { # 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.
+  "destinations": [
+    {
+      "linkedAccount": {
+        "accountId": "A String",
+        "accountType": "A String",
+        "product": "A String",
       },
-      "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.
+      "loginAccount": {
+        "accountId": "A String",
+        "accountType": "A String",
+        "product": "A String",
       },
-      "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.
+      "operatingAccount": {
+        "accountId": "A String",
+        "accountType": "A String",
+        "product": "A String",
       },
-      "productDestinationId": "A String", # Optional. 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. This field is optional for Google Ad Manager event ingestion and User ingestion. Required for all other use cases.
-      "reference": "A String", # Optional. ID for this `Destination` resource, unique within the request. Use to reference this `Destination` in the IngestEventsRequest and IngestAudienceMembersRequest.
+      "productDestinationId": "A String",
+      "reference": "A String",
     },
   ],
-  "encoding": "A String", # Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non `UserData` uploads, this field is ignored.
-  "encryptionInfo": { # Encryption information for the data being ingested. # Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored.
-    "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}`
-      "keyType": "A String", # Required. The type of algorithm used to encrypt the data.
-      "roleArn": "A String", # Required. The Amazon Resource Name of the IAM Role to assume for KMS decryption access. Should be in the format of `arn:{partition}:iam::{account_id}:role/{role_name}`
+  "encoding": "A String",
+  "encryptionInfo": {
+    "awsWrappedKeyInfo": {
+      "encryptedDek": "A String",
+      "kekUri": "A String",
+      "keyType": "A String",
+      "roleArn": "A String",
     },
-    "coordinatorKeyInfo": { # Information about the coordinator key. # Key information for the chosen coordinator key. This is not supported for the IngestEvents, IngestAudienceMembers, and RemoveAudienceMembers methods.
-      "keyId": "A String", # Required. The ID of the chosen coordinator key.
+    "coordinatorKeyInfo": {
+      "keyId": "A String",
     },
-    "gcpWrappedKeyInfo": { # Information about the Google Cloud Platform wrapped key. # Google Cloud Platform wrapped key information.
-      "encryptedDek": "A String", # Required. The base64 encoded encrypted data encryption key.
-      "kekUri": "A String", # Required. Google Cloud Platform [Cloud Key Management Service resource ID](//cloud.google.com/kms/docs/getting-resource-ids). Should be in the format of `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}` or `gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}`
-      "keyType": "A String", # Required. The type of algorithm used to encrypt the data.
-      "wipProvider": "A String", # Required. The [Workload Identity](//cloud.google.com/iam/docs/workload-identity-federation) pool provider required to use KEK.
+    "gcpWrappedKeyInfo": {
+      "encryptedDek": "A String",
+      "kekUri": "A String",
+      "keyType": "A String",
+      "wipProvider": "A String",
     },
   },
-  "termsOfService": { # The terms of service that the user has accepted/rejected. # Optional. The terms of service that the user has accepted/rejected.
-    "customerMatchTermsOfServiceStatus": "A String", # Optional. The Customer Match terms of service: https://support.google.com/adspolicy/answer/6299717. This must be accepted when ingesting UserData or MobileData. This field is not required for Partner Match User list.
+  "termsOfService": {
+    "customerMatchTermsOfServiceStatus": "A String",
   },
-  "validateOnly": True or False, # Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.
+  "validateOnly": True or False,
 }
 
   x__xgafv: string, V1 error format.
@@ -240,149 +240,149 @@ 

Method Details

Returns: 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. + { + "fieldWarnings": [ + { + "description": "A String", + "field": "A String", + "reason": "A String", }, ], - "requestId": "A String", # The auto-generated ID of the request. + "requestId": "A String", }
remove(body=None, x__xgafv=None) -
Removes a list of AudienceMember resources from the provided Destination.
+  
 
 Args:
   body: object, The request body.
     The object takes the form of:
 
-{ # Request to remove users from an audience in the provided destinations. Returns a RemoveAudienceMembersResponse.
-  "audienceMembers": [ # Required. The list of users to remove.
-    { # The audience member to be operated on.
-      "compositeData": { # Composite data holding identifiers and associated data for a user. At least one of `user_data` or `ip_data` is required. # Group of multiple identifier types.
-        "ipData": [ # Optional. IP address data representing customer interaction used to build the audience.
-          { # IP address information for a user. We recommend including observe_start_time and observe_end_time to help improve Customer Match match rates.
-            "ipAddress": "A String", # Required. IP address captured at the time of customer interaction. Accepts standard string formats for both IPv4 and IPv6.
-            "observeEndTime": "A String", # Optional. Last recorded interaction time from this IP address in a session.
-            "observeStartTime": "A String", # Optional. First recorded interaction time from this IP address in a session.
+{
+  "audienceMembers": [
+    {
+      "compositeData": {
+        "ipData": [
+          {
+            "ipAddress": "A String",
+            "observeEndTime": "A String",
+            "observeStartTime": "A String",
           },
         ],
-        "userData": { # Data that identifies the user. At least one identifier is required. # Optional. User-provided data that identifies the user.
-          "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.
-                "regionCode": "A String", # Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.
+        "userData": {
+          "userIdentifiers": [
+            {
+              "address": {
+                "addressLine": "A String",
+                "administrativeArea": "A String",
+                "city": "A String",
+                "familyName": "A String",
+                "givenName": "A String",
+                "postalCode": "A String",
+                "regionCode": "A String",
               },
-              "emailAddress": "A String", # Hashed email address using SHA-256 hash function after normalization.
-              "phoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard).
+              "emailAddress": "A String",
+              "phoneNumber": "A String",
             },
           ],
         },
       },
-      "consent": { # [Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user. # Optional. The consent setting for the user.
-        "adPersonalization": "A String", # Optional. Represents if the user consents to ad personalization.
-        "adUserData": "A String", # Optional. Represents if the user consents to ad user data.
+      "consent": {
+        "adPersonalization": "A String",
+        "adUserData": "A String",
       },
-      "destinationReferences": [ # Optional. Defines which Destination to send the audience member to.
+      "destinationReferences": [
         "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.
+      "googleUserIdData": {
+        "googleUserIds": [
           "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 (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.
+      "mobileData": {
+        "mobileIds": [
           "A String",
         ],
       },
-      "pairData": { # [PAIR](//support.google.com/admanager/answer/15067908) IDs for the audience. At least one PAIR ID is required. This feature is only available to data partners. # [Publisher Advertiser Identity Reconciliation (PAIR) IDs](//support.google.com/admanager/answer/15067908). This feature is only available to data partners.
-        "pairIds": [ # Required. Cleanroom-provided PII data, hashed with SHA256, and encrypted with an EC commutative cipher using publisher key for the [PAIR]((//support.google.com/admanager/answer/15067908)) user list. At most 10 `pairIds` can be provided in a single AudienceMember.
+      "pairData": {
+        "pairIds": [
           "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.
+      "partnerProvidedIdData": {
+        "partnerProvidedIds": [
           "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.
+      "ppidData": {
+        "ppids": [
           "A String",
         ],
       },
-      "userData": { # Data that identifies the user. At least one identifier is required. # User-provided data that identifies the user.
-        "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.
-              "regionCode": "A String", # Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.
+      "userData": {
+        "userIdentifiers": [
+          {
+            "address": {
+              "addressLine": "A String",
+              "administrativeArea": "A String",
+              "city": "A String",
+              "familyName": "A String",
+              "givenName": "A String",
+              "postalCode": "A String",
+              "regionCode": "A String",
             },
-            "emailAddress": "A String", # Hashed email address using SHA-256 hash function after normalization.
-            "phoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard).
+            "emailAddress": "A String",
+            "phoneNumber": "A String",
           },
         ],
       },
-      "userIdData": { # User id data holding the user id. # Data related to unique identifiers for a user, as defined by the advertiser.
-        "userId": "A String", # Required. A unique identifier for a user, as defined by the advertiser.
+      "userIdData": {
+        "userId": "A String",
       },
     },
   ],
-  "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.
+  "destinations": [
+    {
+      "linkedAccount": {
+        "accountId": "A String",
+        "accountType": "A String",
+        "product": "A String",
       },
-      "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.
+      "loginAccount": {
+        "accountId": "A String",
+        "accountType": "A String",
+        "product": "A String",
       },
-      "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.
+      "operatingAccount": {
+        "accountId": "A String",
+        "accountType": "A String",
+        "product": "A String",
       },
-      "productDestinationId": "A String", # Optional. 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. This field is optional for Google Ad Manager event ingestion and User ingestion. Required for all other use cases.
-      "reference": "A String", # Optional. ID for this `Destination` resource, unique within the request. Use to reference this `Destination` in the IngestEventsRequest and IngestAudienceMembersRequest.
+      "productDestinationId": "A String",
+      "reference": "A String",
     },
   ],
-  "encoding": "A String", # Optional. Required for UserData uploads. The encoding type of the user identifiers. Applies to only the outer encoding for encrypted user identifiers. For non `UserData` uploads, this field is ignored.
-  "encryptionInfo": { # Encryption information for the data being ingested. # Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored.
-    "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}`
-      "keyType": "A String", # Required. The type of algorithm used to encrypt the data.
-      "roleArn": "A String", # Required. The Amazon Resource Name of the IAM Role to assume for KMS decryption access. Should be in the format of `arn:{partition}:iam::{account_id}:role/{role_name}`
+  "encoding": "A String",
+  "encryptionInfo": {
+    "awsWrappedKeyInfo": {
+      "encryptedDek": "A String",
+      "kekUri": "A String",
+      "keyType": "A String",
+      "roleArn": "A String",
     },
-    "coordinatorKeyInfo": { # Information about the coordinator key. # Key information for the chosen coordinator key. This is not supported for the IngestEvents, IngestAudienceMembers, and RemoveAudienceMembers methods.
-      "keyId": "A String", # Required. The ID of the chosen coordinator key.
+    "coordinatorKeyInfo": {
+      "keyId": "A String",
     },
-    "gcpWrappedKeyInfo": { # Information about the Google Cloud Platform wrapped key. # Google Cloud Platform wrapped key information.
-      "encryptedDek": "A String", # Required. The base64 encoded encrypted data encryption key.
-      "kekUri": "A String", # Required. Google Cloud Platform [Cloud Key Management Service resource ID](//cloud.google.com/kms/docs/getting-resource-ids). Should be in the format of `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}` or `gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}`
-      "keyType": "A String", # Required. The type of algorithm used to encrypt the data.
-      "wipProvider": "A String", # Required. The [Workload Identity](//cloud.google.com/iam/docs/workload-identity-federation) pool provider required to use KEK.
+    "gcpWrappedKeyInfo": {
+      "encryptedDek": "A String",
+      "kekUri": "A String",
+      "keyType": "A String",
+      "wipProvider": "A String",
     },
   },
-  "validateOnly": True or False, # Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.
+  "validateOnly": True or False,
 }
 
   x__xgafv: string, V1 error format.
@@ -393,43 +393,43 @@ 

Method Details

Returns: An object of the form: - { # Response from the RemoveAudienceMembersRequest. - "requestId": "A String", # The auto-generated ID of the request. + { + "requestId": "A String", }
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.
+{
+  "destinations": [
+    {
+      "linkedAccount": {
+        "accountId": "A String",
+        "accountType": "A String",
+        "product": "A String",
       },
-      "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.
+      "loginAccount": {
+        "accountId": "A String",
+        "accountType": "A String",
+        "product": "A String",
       },
-      "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.
+      "operatingAccount": {
+        "accountId": "A String",
+        "accountType": "A String",
+        "product": "A String",
       },
-      "productDestinationId": "A String", # Optional. 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. This field is optional for Google Ad Manager event ingestion and User ingestion. Required for all other use cases.
-      "reference": "A String", # Optional. ID for this `Destination` resource, unique within the request. Use to reference this `Destination` in the IngestEventsRequest and IngestAudienceMembersRequest.
+      "productDestinationId": "A String",
+      "reference": "A String",
     },
   ],
-  "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.
+  "removeAsOfTime": "A String",
+  "validateOnly": True or False,
 }
 
   x__xgafv: string, V1 error format.
@@ -440,8 +440,8 @@ 

Method Details

Returns: An object of the form: - { # Response from the RemoveAllAudienceMembersRequest. - "requestId": "A String", # The auto-generated ID of the request. + { + "requestId": "A String", }
diff --git a/docs/dyn/datamanager_v1.events.html b/docs/dyn/datamanager_v1.events.html index e37eca57be..f10c381453 100644 --- a/docs/dyn/datamanager_v1.events.html +++ b/docs/dyn/datamanager_v1.events.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

ingest(body=None, x__xgafv=None)

-

Uploads a list of Event resources from the provided Destination.

+

Method Details

close() @@ -88,234 +88,236 @@

Method Details

ingest(body=None, x__xgafv=None) -
Uploads a list of Event resources from the provided Destination.
+  
 
 Args:
   body: object, The request body.
     The object takes the form of:
 
-{ # Request to upload audience members to the provided destinations. Returns an IngestEventsResponse.
-  "consent": { # [Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user. # Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each Event.
-    "adPersonalization": "A String", # Optional. Represents if the user consents to ad personalization.
-    "adUserData": "A String", # Optional. Represents if the user consents to ad user data.
+{
+  "consent": {
+    "adPersonalization": "A String",
+    "adUserData": "A String",
   },
-  "destinations": [ # Required. The list of destinations to send the events to.
-    { # 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.
+  "destinations": [
+    {
+      "linkedAccount": {
+        "accountId": "A String",
+        "accountType": "A String",
+        "product": "A String",
       },
-      "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.
+      "loginAccount": {
+        "accountId": "A String",
+        "accountType": "A String",
+        "product": "A String",
       },
-      "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.
+      "operatingAccount": {
+        "accountId": "A String",
+        "accountType": "A String",
+        "product": "A String",
       },
-      "productDestinationId": "A String", # Optional. 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. This field is optional for Google Ad Manager event ingestion and User ingestion. Required for all other use cases.
-      "reference": "A String", # Optional. ID for this `Destination` resource, unique within the request. Use to reference this `Destination` in the IngestEventsRequest and IngestAudienceMembersRequest.
+      "productDestinationId": "A String",
+      "reference": "A String",
     },
   ],
-  "encoding": "A String", # Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non `UserData` uploads, this field is ignored.
-  "encryptionInfo": { # Encryption information for the data being ingested. # Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored.
-    "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}`
-      "keyType": "A String", # Required. The type of algorithm used to encrypt the data.
-      "roleArn": "A String", # Required. The Amazon Resource Name of the IAM Role to assume for KMS decryption access. Should be in the format of `arn:{partition}:iam::{account_id}:role/{role_name}`
+  "encoding": "A String",
+  "encryptionInfo": {
+    "awsWrappedKeyInfo": {
+      "encryptedDek": "A String",
+      "kekUri": "A String",
+      "keyType": "A String",
+      "roleArn": "A String",
     },
-    "coordinatorKeyInfo": { # Information about the coordinator key. # Key information for the chosen coordinator key. This is not supported for the IngestEvents, IngestAudienceMembers, and RemoveAudienceMembers methods.
-      "keyId": "A String", # Required. The ID of the chosen coordinator key.
+    "coordinatorKeyInfo": {
+      "keyId": "A String",
     },
-    "gcpWrappedKeyInfo": { # Information about the Google Cloud Platform wrapped key. # Google Cloud Platform wrapped key information.
-      "encryptedDek": "A String", # Required. The base64 encoded encrypted data encryption key.
-      "kekUri": "A String", # Required. Google Cloud Platform [Cloud Key Management Service resource ID](//cloud.google.com/kms/docs/getting-resource-ids). Should be in the format of `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}` or `gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}`
-      "keyType": "A String", # Required. The type of algorithm used to encrypt the data.
-      "wipProvider": "A String", # Required. The [Workload Identity](//cloud.google.com/iam/docs/workload-identity-federation) pool provider required to use KEK.
+    "gcpWrappedKeyInfo": {
+      "encryptedDek": "A String",
+      "kekUri": "A String",
+      "keyType": "A String",
+      "wipProvider": "A String",
     },
   },
-  "events": [ # Required. The list of events to send to the specified destinations. At most 2000 Event resources can be sent in a single request.
-    { # An event representing a user interaction with an advertiser's website or app.
-      "adIdentifiers": { # Identifiers and other information used to match the conversion event with other online activity (such as ad clicks). # Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).
-        "dclid": "A String", # Optional. The display click ID associated with this event.
-        "encryptedUserIds": [ # Optional. Any number of encrypted user IDs.
-          { # A user identifier issued to be used for attribution. All fields are required if this is used.
-            "encryptedId": "A String", # Required. The alphanumeric encrypted id.
-            "entityId": "A String", # Required. The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
-            "entityType": "A String", # Required. The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.
-            "source": "A String", # Required. Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.
+  "events": [
+    {
+      "adIdentifiers": {
+        "dclid": "A String",
+        "encryptedUserIds": [
+          {
+            "encryptedId": "A String",
+            "entityId": "A String",
+            "entityType": "A String",
+            "source": "A String",
           },
         ],
-        "gbraid": "A String", # Optional. The click identifier for clicks associated with app events and originating from iOS devices starting with iOS14.
-        "gclid": "A String", # Optional. The Google click ID (gclid) associated with this event.
-        "impressionId": "A String", # Optional. The impression ID associated with this event.
-        "landingPageDeviceInfo": { # Information about the device being used (if any) when the event happened. # Optional. Information gathered about the device being used (if any) at the time of landing onto the advertiser’s site after interacting with the ad.
-          "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. Required when used in an AdEvent.
-          "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.
-          "operatingSystemVersion": "A String", # Optional. The version of the operating system or platform.
-          "screenHeight": 42, # Optional. The height of the screen in pixels.
-          "screenWidth": 42, # Optional. The width of the screen in pixels.
-          "userAgent": "A String", # Optional. The user-agent string of the device for the given context.
+        "gbraid": "A String",
+        "gclid": "A String",
+        "impressionId": "A String",
+        "landingPageDeviceInfo": {
+          "brand": "A String",
+          "browser": "A String",
+          "browserVersion": "A String",
+          "category": "A String",
+          "ipAddress": "A String",
+          "languageCode": "A String",
+          "model": "A String",
+          "operatingSystem": "A String",
+          "operatingSystemVersion": "A String",
+          "screenHeight": 42,
+          "screenWidth": 42,
+          "userAgent": "A String",
         },
-        "matchId": "A String", # Optional. The match ID field used to join this event with a previous event.
-        "mobileDeviceId": "A String", # Optional. The mobile identifier for advertisers. This would be IDFA on iOS, AdID on Android, or other platforms’ identifiers for advertisers.
-        "sessionAttributes": "A String", # Optional. Session attributes for event attribution and modeling.
-        "wbraid": "A String", # Optional. The click identifier for clicks associated with web events and originating from iOS devices starting with iOS14.
+        "matchId": "A String",
+        "mobileDeviceId": "A String",
+        "ppid": "A String",
+        "sessionAttributes": "A String",
+        "visitorPpid": "A String",
+        "wbraid": "A String",
       },
-      "additionalEventParameters": [ # Optional. A bucket of any [event parameters](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.
-        { # Event parameter for GA4 events.
-          "parameterName": "A String", # Required. The name of the parameter to use.
-          "value": "A String", # Required. The string representation of the value of the parameter to set.
+      "additionalEventParameters": [
+        {
+          "parameterName": "A String",
+          "value": "A String",
         },
       ],
-      "appInstanceId": "A String", # Optional. A unique identifier for the user instance of an app client for this GA4 app stream.
-      "cartData": { # The cart data associated with the event. # Optional. Information about the transaction and items associated with the event.
-        "couponCodes": [ # Optional. The list of coupon codes that were applied to the cart. Cart-level and item-level coupon codes are independent. If the event is for a Google Analytics destination, only provide a single coupon code. Google Analytics ignores additional coupon codes.
+      "appInstanceId": "A String",
+      "cartData": {
+        "couponCodes": [
           "A String",
         ],
-        "items": [ # Optional. The list of items associated with the event.
-          { # Represents an item in the cart associated with the event.
-            "additionalItemParameters": [ # Optional. A bucket of any [event parameters related to an item](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.
-              { # A bucket of any [event parameters related to an item](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.
-                "parameterName": "A String", # Required. The name of the parameter to use.
-                "value": "A String", # Required. The string representation of the value of the parameter to set.
+        "items": [
+          {
+            "additionalItemParameters": [
+              {
+                "parameterName": "A String",
+                "value": "A String",
               },
             ],
-            "conversionValue": 3.14, # Optional. The conversion value associated with this item within the event, for cases where the conversion value is different for each item.
-            "customVariables": [ # Optional. Additional key/value pair information to send to the conversion containers (conversion action or Floodlight activity), when tracking per-item conversions.
-              { # Item-level custom variable for ads conversions.
-                "destinationReferences": [ # Optional. Reference string used to determine which of the Event.destination_references the custom variable should be sent to. If empty, the Event.destination_references will be used.
+            "conversionValue": 3.14,
+            "customVariables": [
+              {
+                "destinationReferences": [
                   "A String",
                 ],
-                "value": "A String", # Optional. The value to store for the custom variable.
-                "variable": "A String", # Optional. The name of the custom variable to set. If the variable is not found for the given destination, it will be ignored.
+                "value": "A String",
+                "variable": "A String",
               },
             ],
-            "itemId": "A String", # Optional. A unique identifier to reference the item.
-            "merchantFeedLabel": "A String", # Optional. The feed label of the Merchant Center feed. If countries are still being used, the 2-letter country code in ISO-3166-1 alpha-2 can be used instead. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.
-            "merchantFeedLanguageCode": "A String", # Optional. The language code in ISO 639-1 associated with the Merchant Center feed where your items are uploaded.
-            "merchantId": "A String", # Optional. The Merchant Center ID associated with the item. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.
-            "merchantProductId": "A String", # Optional. The product ID within the Merchant Center account.
-            "quantity": "A String", # Optional. The number of this item associated with the event.
-            "unitPrice": 3.14, # Optional. The unit price excluding tax, shipping, and any transaction level discounts.
+            "itemId": "A String",
+            "merchantFeedLabel": "A String",
+            "merchantFeedLanguageCode": "A String",
+            "merchantId": "A String",
+            "merchantProductId": "A String",
+            "quantity": "A String",
+            "unitPrice": 3.14,
           },
         ],
-        "merchantFeedLabel": "A String", # Optional. The Merchant Center feed label associated with the feed of the items.
-        "merchantFeedLanguageCode": "A String", # Optional. The language code in ISO 639-1 associated with the Merchant Center feed of the items.where your items are uploaded.
-        "merchantId": "A String", # Optional. The Merchant Center ID associated with the items.
-        "transactionDiscount": 3.14, # Optional. The sum of all discounts associated with the transaction.
+        "merchantFeedLabel": "A String",
+        "merchantFeedLanguageCode": "A String",
+        "merchantId": "A String",
+        "transactionDiscount": 3.14,
       },
-      "clientId": "A String", # Optional. A unique identifier for the user instance of a web client for this GA4 web stream.
-      "consent": { # [Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user. # Optional. Information about whether the associated user has provided different types of consent.
-        "adPersonalization": "A String", # Optional. Represents if the user consents to ad personalization.
-        "adUserData": "A String", # Optional. Represents if the user consents to ad user data.
+      "clientId": "A String",
+      "consent": {
+        "adPersonalization": "A String",
+        "adUserData": "A String",
       },
-      "conversionCount": 3.14, # Optional. The conversion quantity associated with the event, for counting-based conversions.
-      "conversionValue": 3.14, # Optional. The conversion value associated with the event, for value-based conversions.
-      "currency": "A String", # Optional. The currency code associated with all monetary values within this event.
-      "customVariables": [ # Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).
-        { # Custom variable for ads conversions.
-          "destinationReferences": [ # Optional. Reference string used to determine which of the Event.destination_references the custom variable should be sent to. If empty, the Event.destination_references will be used.
+      "conversionCount": 3.14,
+      "conversionValue": 3.14,
+      "currency": "A String",
+      "customVariables": [
+        {
+          "destinationReferences": [
             "A String",
           ],
-          "value": "A String", # Optional. The value to store for the custom variable.
-          "variable": "A String", # Optional. The name of the custom variable to set. If the variable is not found for the given destination, it will be ignored.
+          "value": "A String",
+          "variable": "A String",
         },
       ],
-      "destinationReferences": [ # Optional. Reference string used to determine the destination. If empty, the event will be sent to all destinations in the request.
+      "destinationReferences": [
         "A String",
       ],
-      "eventDeviceInfo": { # Information about the device being used (if any) when the event happened. # Optional. Information gathered about the device being used (if any) when the 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. Required when used in an AdEvent.
-        "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.
-        "operatingSystemVersion": "A String", # Optional. The version of the operating system or platform.
-        "screenHeight": 42, # Optional. The height of the screen in pixels.
-        "screenWidth": 42, # Optional. The width of the screen in pixels.
-        "userAgent": "A String", # Optional. The user-agent string of the device for the given context.
+      "eventDeviceInfo": {
+        "brand": "A String",
+        "browser": "A String",
+        "browserVersion": "A String",
+        "category": "A String",
+        "ipAddress": "A String",
+        "languageCode": "A String",
+        "model": "A String",
+        "operatingSystem": "A String",
+        "operatingSystemVersion": "A String",
+        "screenHeight": 42,
+        "screenWidth": 42,
+        "userAgent": "A String",
       },
-      "eventLocation": { # The location where the event occurred. # Optional. Information gathered about the location of the user when this event occurred.
-        "city": "A String", # Optional. The name of the city where the event occurred.
-        "continentCode": "A String", # Optional. The continent code in UN M49 format where the event occurred.
-        "regionCode": "A String", # Optional. The 2-letter CLDR region code of the user's address.
-        "storeId": "A String", # Optional. Required for Store Sales. The identifier to represent a physical store where the event happened.
-        "subcontinentCode": "A String", # Optional. The subcontinent code in UN M49 format where the event occurred.
-        "subdivisionCode": "A String", # Optional. The ISO 3166-2 subdivision code where the event occurred.
+      "eventLocation": {
+        "city": "A String",
+        "continentCode": "A String",
+        "regionCode": "A String",
+        "storeId": "A String",
+        "subcontinentCode": "A String",
+        "subdivisionCode": "A String",
       },
-      "eventName": "A String", # Optional. The name of the event. Required for GA4 events.
-      "eventSource": "A String", # Optional. Signal for where the event happened (web, app, in-store, etc.).
-      "eventTimestamp": "A String", # Required. The time the event occurred.
-      "experimentalFields": [ # Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.
-        { # Experimental field representing unofficial fields.
-          "field": "A String", # Optional. The name of the field to use.
-          "value": "A String", # Optional. The value the field to set.
+      "eventName": "A String",
+      "eventSource": "A String",
+      "eventTimestamp": "A String",
+      "experimentalFields": [
+        {
+          "field": "A String",
+          "value": "A String",
         },
       ],
-      "lastUpdatedTimestamp": "A String", # Optional. The last time the event was updated.
-      "thirdPartyUserData": { # Data that identifies the user. At least one identifier is required. # Optional. The same type of data provided in user_data, but explicitly flagged as being provided as owned by a third-party and not first-party advertiser data.
-        "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.
-              "regionCode": "A String", # Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.
+      "lastUpdatedTimestamp": "A String",
+      "thirdPartyUserData": {
+        "userIdentifiers": [
+          {
+            "address": {
+              "addressLine": "A String",
+              "administrativeArea": "A String",
+              "city": "A String",
+              "familyName": "A String",
+              "givenName": "A String",
+              "postalCode": "A String",
+              "regionCode": "A String",
             },
-            "emailAddress": "A String", # Hashed email address using SHA-256 hash function after normalization.
-            "phoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard).
+            "emailAddress": "A String",
+            "phoneNumber": "A String",
           },
         ],
       },
-      "transactionId": "A String", # Optional. The unique identifier for this event. Required for events sent as an additional data source for tag conversions.
-      "userData": { # Data that identifies the user. At least one identifier is required. # Optional. Pieces of user provided data, representing the user the event is associated with.
-        "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.
-              "regionCode": "A String", # Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.
+      "transactionId": "A String",
+      "userData": {
+        "userIdentifiers": [
+          {
+            "address": {
+              "addressLine": "A String",
+              "administrativeArea": "A String",
+              "city": "A String",
+              "familyName": "A String",
+              "givenName": "A String",
+              "postalCode": "A String",
+              "regionCode": "A String",
             },
-            "emailAddress": "A String", # Hashed email address using SHA-256 hash function after normalization.
-            "phoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard).
+            "emailAddress": "A String",
+            "phoneNumber": "A String",
           },
         ],
       },
-      "userId": "A String", # Optional. A unique identifier for a user, as defined by the advertiser.
-      "userProperties": { # Advertiser-assessed information about the user at the time that the event happened. See https://support.google.com/google-ads/answer/14007601 for more details. # Optional. Advertiser-assessed information about the user at the time that the event happened.
-        "additionalUserProperties": [ # Optional. A bucket of any additional [user properties](https://developers.google.com/analytics/devguides/collection/protocol/ga4/user-properties) for the user associated with this event.
-          { # A bucket of any additional [user properties](https://developers.google.com/analytics/devguides/collection/protocol/ga4/user-properties) for the user associated with this event.
-            "propertyName": "A String", # Required. The name of the user property to use.
-            "value": "A String", # Required. The string representation of the value of the user property to use.
+      "userId": "A String",
+      "userProperties": {
+        "additionalUserProperties": [
+          {
+            "propertyName": "A String",
+            "value": "A String",
           },
         ],
-        "customerType": "A String", # Optional. Type of the customer associated with the event.
-        "customerValueBucket": "A String", # Optional. The advertiser-assessed value of the customer.
+        "customerType": "A String",
+        "customerValueBucket": "A String",
       },
     },
   ],
-  "validateOnly": True or False, # Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.
+  "validateOnly": True or False,
 }
 
   x__xgafv: string, V1 error format.
@@ -326,15 +328,15 @@ 

Method Details

Returns: 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. + { + "fieldWarnings": [ + { + "description": "A String", + "field": "A String", + "reason": "A String", }, ], - "requestId": "A String", # The auto-generated ID of the request. + "requestId": "A String", }
diff --git a/docs/dyn/datamanager_v1.requestStatus.html b/docs/dyn/datamanager_v1.requestStatus.html index 2c280da747..2e45772c0a 100644 --- a/docs/dyn/datamanager_v1.requestStatus.html +++ b/docs/dyn/datamanager_v1.requestStatus.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

retrieve(requestId=None, x__xgafv=None)

-

Gets the status of a request given request id.

+

Method Details

close() @@ -88,10 +88,10 @@

Method Details

retrieve(requestId=None, x__xgafv=None) -
Gets the status of a request given request id.
+  
 
 Args:
-  requestId: string, Required. Required. The request ID of the Data Manager API request.
+  requestId: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -100,127 +100,127 @@ 

Method Details

Returns: An object of the form: - { # Response from the RetrieveRequestStatusRequest. - "requestStatusPerDestination": [ # A list of request statuses per destination. The order of the statuses matches the order of the destinations in the original request. - { # A request status per destination. - "audienceMembersIngestionStatus": { # The status of the ingest audience members request. # The status of the ingest audience members request. - "compositeDataIngestionStatus": { # The status of the composite data ingestion to the destination containing stats related to the ingestion. # The status of the composite data ingestion to the destination. - "dataTypeCounts": [ # The total count of data types sent in the upload request for the destination, broken down by data type. Includes all data types in the request, regardless of whether they were successfully ingested or not. - { # The count for a specific data type. - "count": "A String", # The count for this data type. - "type": "A String", # The type of data. + { + "requestStatusPerDestination": [ + { + "audienceMembersIngestionStatus": { + "compositeDataIngestionStatus": { + "dataTypeCounts": [ + { + "count": "A String", + "type": "A String", }, ], - "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. + "recordCount": "A String", + "uploadMatchRateRange": "A String", }, - "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. + "googleUserIdDataIngestionStatus": { + "googleUserIdCount": "A String", + "recordCount": "A String", }, - "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. + "mobileDataIngestionStatus": { + "mobileIdCount": "A String", + "recordCount": "A String", }, - "pairDataIngestionStatus": { # The status of the pair data ingestion to the destination containing stats related to the ingestion. # The status of the pair data ingestion to the destination. - "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. + "pairDataIngestionStatus": { + "pairIdCount": "A String", + "recordCount": "A String", }, - "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. + "partnerProvidedIdDataIngestionStatus": { + "partnerProvidedIdCount": "A String", + "recordCount": "A String", }, - "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. + "ppidDataIngestionStatus": { + "ppidCount": "A String", + "recordCount": "A String", }, - "userDataIngestionStatus": { # The status of the user data ingestion to the destination containing stats related to the ingestion. # The status of the user data ingestion to the destination. - "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. - "userIdentifierCount": "A String", # The total count of user identifiers sent in the upload request for the destination. Includes all user identifiers in the request, regardless of whether they were successfully ingested or not. + "userDataIngestionStatus": { + "recordCount": "A String", + "uploadMatchRateRange": "A String", + "userIdentifierCount": "A String", }, - "userIdDataIngestionStatus": { # The status of the user id data ingestion to the destination containing stats related to the ingestion. # The status of the user id data ingestion to the destination. - "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. - "userIdCount": "A String", # The total count of user ids sent in the upload request for the destination. Includes all user ids in the request, regardless of whether they were successfully ingested or not. + "userIdDataIngestionStatus": { + "recordCount": "A String", + "userIdCount": "A String", }, }, - "audienceMembersRemovalStatus": { # The status of the remove audience members request. # The status of the remove audience members request. - "compositeDataRemovalStatus": { # The status of the composite data removal from the destination. # The status of the composite data removal from the destination. - "dataTypeCounts": [ # The total count of data types sent in the removal request, broken down by data type. Includes all data types in the request, regardless of whether they were successfully removed or not. - { # The count for a specific data type. - "count": "A String", # The count for this data type. - "type": "A String", # The type of data. + "audienceMembersRemovalStatus": { + "compositeDataRemovalStatus": { + "dataTypeCounts": [ + { + "count": "A String", + "type": "A String", }, ], - "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. + "recordCount": "A String", }, - "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. + "googleUserIdDataRemovalStatus": { + "googleUserIdCount": "A String", + "recordCount": "A String", }, - "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. + "mobileDataRemovalStatus": { + "mobileIdCount": "A String", + "recordCount": "A String", }, - "pairDataRemovalStatus": { # The status of the pair data removal from the destination. # The status of the pair data removal from the destination. - "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. + "pairDataRemovalStatus": { + "pairIdCount": "A String", + "recordCount": "A String", }, - "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. + "partnerProvidedIdDataRemovalStatus": { + "partnerProvidedIdCount": "A String", + "recordCount": "A String", }, - "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. + "ppidDataRemovalStatus": { + "ppidCount": "A String", + "recordCount": "A String", }, - "userDataRemovalStatus": { # The status of the user data removal from the destination. # The status of the user data removal from the destination. - "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. - "userIdentifierCount": "A String", # The total count of user identifiers sent in the removal request. Includes all user identifiers in the request, regardless of whether they were successfully removed or not. + "userDataRemovalStatus": { + "recordCount": "A String", + "userIdentifierCount": "A String", }, - "userIdDataRemovalStatus": { # The status of the user id data removal from the destination. # The status of the user id data removal from the destination. - "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. - "userIdCount": "A String", # The total count of user ids sent in the removal request. Includes all user ids in the request, regardless of whether they were successfully removed or not. + "userIdDataRemovalStatus": { + "recordCount": "A String", + "userIdCount": "A String", }, }, - "destination": { # The Google product you're sending data to. For example, a Google Ads account. # A destination within a DM API request. - "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", # Optional. 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. This field is optional for Google Ad Manager event ingestion and User ingestion. Required for all other use cases. - "reference": "A String", # Optional. ID for this `Destination` resource, unique within the request. Use to reference this `Destination` in the IngestEventsRequest and IngestAudienceMembersRequest. + "destination": { + "linkedAccount": { + "accountId": "A String", + "accountType": "A String", + "product": "A String", + }, + "loginAccount": { + "accountId": "A String", + "accountType": "A String", + "product": "A String", + }, + "operatingAccount": { + "accountId": "A String", + "accountType": "A String", + "product": "A String", + }, + "productDestinationId": "A String", + "reference": "A String", }, - "errorInfo": { # Error counts for each type of error. # An error info error containing the error reason and error counts related to the upload. Only populated if the `request_status` is `FAILED` or `PARTIAL_SUCCESS`. This field isn't populated while the request has `request_status` of `PROCESSING`. - "errorCounts": [ # A list of errors and counts per error reason. May not be populated in all cases. - { # The error count for a given error reason. - "reason": "A String", # The error reason of the failed records. - "recordCount": "A String", # The count of records that failed to upload for a given reason. + "errorInfo": { + "errorCounts": [ + { + "reason": "A String", + "recordCount": "A String", }, ], }, - "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. + "eventsIngestionStatus": { + "recordCount": "A String", }, - "removeAllAudienceMembersStatus": { # The status of the remove all audience members request. # The status of the remove all audience members request. + "removeAllAudienceMembersStatus": { }, - "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. - { # The warning count for a given warning reason. - "reason": "A String", # The warning reason. - "recordCount": "A String", # The count of records that have a warning. + "requestStatus": "A String", + "warningInfo": { + "warningCounts": [ + { + "reason": "A String", + "recordCount": "A String", }, ], }, diff --git a/googleapiclient/discovery_cache/documents/datamanager.v1.json b/googleapiclient/discovery_cache/documents/datamanager.v1.json index 8ad80bc402..1b7490e1b0 100644 --- a/googleapiclient/discovery_cache/documents/datamanager.v1.json +++ b/googleapiclient/discovery_cache/documents/datamanager.v1.json @@ -115,7 +115,7 @@ "insights": { "methods": { "retrieve": { -"description": "Retrieves marketing data insights for a given user list. This feature is only available to data partners. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/insights:retrieve", "httpMethod": "POST", "id": "datamanager.accountTypes.accounts.insights.retrieve", @@ -124,7 +124,6 @@ ], "parameters": { "parent": { -"description": "Required. The parent account that owns the user list. Format: `accountTypes/{account_type}/accounts/{account}`", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+$", "required": true, @@ -147,7 +146,7 @@ "partnerLinks": { "methods": { "create": { -"description": "Creates a partner link for the given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}`", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/partnerLinks", "httpMethod": "POST", "id": "datamanager.accountTypes.accounts.partnerLinks.create", @@ -156,7 +155,6 @@ ], "parameters": { "parent": { -"description": "Required. The parent, which owns this collection of partner links. Format: accountTypes/{account_type}/accounts/{account}", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+$", "required": true, @@ -176,7 +174,7 @@ ] }, "delete": { -"description": "Deletes a partner link for the given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}`", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/partnerLinks/{partnerLinksId}", "httpMethod": "DELETE", "id": "datamanager.accountTypes.accounts.partnerLinks.delete", @@ -185,7 +183,6 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the partner link to delete. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+/partnerLinks/[^/]+$", "required": true, @@ -202,7 +199,7 @@ ] }, "search": { -"description": "Searches for all partner links to and from a given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}`", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/partnerLinks:search", "httpMethod": "GET", "id": "datamanager.accountTypes.accounts.partnerLinks.search", @@ -211,23 +208,19 @@ ], "parameters": { "filter": { -"description": "Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` - `feature_set` For partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set, the following fields are also supported: - `partner_customer_account.account_id` - `partner_link_metadata.implicit_accounts.account_id` Example: `owning_account.account_type = \"GOOGLE_ADS\" AND partner_account.account_id = 987654321`", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 50 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `SearchPartnerLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchPartnerLinks` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Account to search for partner links. If no `filter` is specified, all partner links where this account is either the `owning_account` or `partner_account` are returned. Format: `accountTypes/{account_type}/accounts/{account}`", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+$", "required": true, @@ -248,7 +241,7 @@ "userListDirectLicenses": { "methods": { "create": { -"description": "Creates a user list direct license. This feature is only available to data partners.", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListDirectLicenses", "httpMethod": "POST", "id": "datamanager.accountTypes.accounts.userListDirectLicenses.create", @@ -257,7 +250,6 @@ ], "parameters": { "parent": { -"description": "Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+$", "required": true, @@ -276,7 +268,7 @@ ] }, "get": { -"description": "Retrieves a user list direct license. This feature is only available to data partners.", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListDirectLicenses/{userListDirectLicensesId}", "httpMethod": "GET", "id": "datamanager.accountTypes.accounts.userListDirectLicenses.get", @@ -285,7 +277,6 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the user list direct license.", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+/userListDirectLicenses/[^/]+$", "required": true, @@ -301,7 +292,7 @@ ] }, "list": { -"description": "Lists all user list direct licenses owned by the parent account. This feature is only available to data partners.", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListDirectLicenses", "httpMethod": "GET", "id": "datamanager.accountTypes.accounts.userListDirectLicenses.list", @@ -310,23 +301,19 @@ ], "parameters": { "filter": { -"description": "Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(user_list_id, 123, 456)` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. The maximum number of licenses to return per page. The service may return fewer than this value. If unspecified, at most 50 licenses 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 `ListUserListDirectLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+$", "required": true, @@ -342,7 +329,7 @@ ] }, "patch": { -"description": "Updates a user list direct license. This feature is only available to data partners.", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListDirectLicenses/{userListDirectLicensesId}", "httpMethod": "PATCH", "id": "datamanager.accountTypes.accounts.userListDirectLicenses.patch", @@ -351,14 +338,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the user list direct license.", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+/userListDirectLicenses/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "Optional. The list of fields to update. The special character `*` is not supported and an `INVALID_UPDATE_MASK` error will be thrown if used.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -380,7 +365,7 @@ "userListGlobalLicenses": { "methods": { "create": { -"description": "Creates a user list global license. This feature is only available to data partners.", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses", "httpMethod": "POST", "id": "datamanager.accountTypes.accounts.userListGlobalLicenses.create", @@ -389,7 +374,6 @@ ], "parameters": { "parent": { -"description": "Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+$", "required": true, @@ -408,7 +392,7 @@ ] }, "get": { -"description": "Retrieves a user list global license. This feature is only available to data partners.", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses/{userListGlobalLicensesId}", "httpMethod": "GET", "id": "datamanager.accountTypes.accounts.userListGlobalLicenses.get", @@ -417,7 +401,6 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the user list global license.", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+/userListGlobalLicenses/[^/]+$", "required": true, @@ -433,7 +416,7 @@ ] }, "list": { -"description": "Lists all user list global licenses owned by the parent account. This feature is only available to data partners.", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses", "httpMethod": "GET", "id": "datamanager.accountTypes.accounts.userListGlobalLicenses.list", @@ -442,23 +425,19 @@ ], "parameters": { "filter": { -"description": "Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(user_list_id, 123, 456)` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses 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 `ListUserListGlobalLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+$", "required": true, @@ -474,7 +453,7 @@ ] }, "patch": { -"description": "Updates a user list global license. This feature is only available to data partners.", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses/{userListGlobalLicensesId}", "httpMethod": "PATCH", "id": "datamanager.accountTypes.accounts.userListGlobalLicenses.patch", @@ -483,14 +462,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the user list global license.", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+/userListGlobalLicenses/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "Optional. The list of fields to update. The special character `*` is not supported and an `INVALID_UPDATE_MASK` error will be thrown if used.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -512,7 +489,7 @@ "userListGlobalLicenseCustomerInfos": { "methods": { "list": { -"description": "Lists all customer info for a user list global license. This feature is only available to data partners.", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses/{userListGlobalLicensesId}/userListGlobalLicenseCustomerInfos", "httpMethod": "GET", "id": "datamanager.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.list", @@ -521,23 +498,19 @@ ], "parameters": { "filter": { -"description": "Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(user_list_id, 123, 456)` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses 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 `ListUserListDirectLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The global license whose customer info are being queried. Should be in the format `accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}`. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, `accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-`)", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+/userListGlobalLicenses/[^/]+$", "required": true, @@ -559,7 +532,7 @@ "userLists": { "methods": { "create": { -"description": "Creates a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists", "httpMethod": "POST", "id": "datamanager.accountTypes.accounts.userLists.create", @@ -568,14 +541,12 @@ ], "parameters": { "parent": { -"description": "Required. The parent account where this user list will be created. Format: accountTypes/{account_type}/accounts/{account}", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+$", "required": true, "type": "string" }, "validateOnly": { -"description": "Optional. If true, the request is validated but not executed.", "location": "query", "type": "boolean" } @@ -592,7 +563,7 @@ ] }, "delete": { -"description": "Deletes a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists/{userListsId}", "httpMethod": "DELETE", "id": "datamanager.accountTypes.accounts.userLists.delete", @@ -601,14 +572,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the user list to delete. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+/userLists/[^/]+$", "required": true, "type": "string" }, "validateOnly": { -"description": "Optional. If true, the request is validated but not executed.", "location": "query", "type": "boolean" } @@ -622,7 +591,7 @@ ] }, "get": { -"description": "Gets a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists/{userListsId}", "httpMethod": "GET", "id": "datamanager.accountTypes.accounts.userLists.get", @@ -631,7 +600,6 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the UserList to retrieve. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+/userLists/[^/]+$", "required": true, @@ -647,7 +615,7 @@ ] }, "list": { -"description": "Lists UserLists. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists", "httpMethod": "GET", "id": "datamanager.accountTypes.accounts.userLists.list", @@ -656,23 +624,19 @@ ], "parameters": { "filter": { -"description": "Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `display_name = \"list 1\"`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` - `:` (has) **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(display_name, \"name1\", \"name2\")` Supported fields: - `id` - `display_name` - `description` - `membership_status` - `integration_code` - `access_reason` - `ingested_user_list_info.upload_key_types`", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists 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 `ListUserLists` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLists` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account}", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+$", "required": true, @@ -688,7 +652,7 @@ ] }, "patch": { -"description": "Updates a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`", +"description": "", "flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists/{userListsId}", "httpMethod": "PATCH", "id": "datamanager.accountTypes.accounts.userLists.patch", @@ -697,20 +661,17 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}", "location": "path", "pattern": "^accountTypes/[^/]+/accounts/[^/]+/userLists/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "Optional. The list of fields to update.", "format": "google-fieldmask", "location": "query", "type": "string" }, "validateOnly": { -"description": "Optional. If true, the request is validated but not executed.", "location": "query", "type": "boolean" } @@ -735,7 +696,7 @@ "adEvents": { "methods": { "ingest": { -"description": "Uploads a list of AdEvent resources to Google Analytics. This feature is only available to accounts on an allowlist.", +"description": "", "flatPath": "v1/adEvents:ingest", "httpMethod": "POST", "id": "datamanager.adEvents.ingest", @@ -757,7 +718,7 @@ "audienceMembers": { "methods": { "ingest": { -"description": "Uploads a list of AudienceMember resources to the provided Destination.", +"description": "", "flatPath": "v1/audienceMembers:ingest", "httpMethod": "POST", "id": "datamanager.audienceMembers.ingest", @@ -775,7 +736,7 @@ ] }, "remove": { -"description": "Removes a list of AudienceMember resources from the provided Destination.", +"description": "", "flatPath": "v1/audienceMembers:remove", "httpMethod": "POST", "id": "datamanager.audienceMembers.remove", @@ -793,7 +754,7 @@ ] }, "removeAll": { -"description": "Removes all audience members from the provided destinations.", +"description": "", "flatPath": "v1/audienceMembers:removeAll", "httpMethod": "POST", "id": "datamanager.audienceMembers.removeAll", @@ -815,7 +776,7 @@ "events": { "methods": { "ingest": { -"description": "Uploads a list of Event resources from the provided Destination.", +"description": "", "flatPath": "v1/events:ingest", "httpMethod": "POST", "id": "datamanager.events.ingest", @@ -837,14 +798,13 @@ "requestStatus": { "methods": { "retrieve": { -"description": "Gets the status of a request given request id.", +"description": "", "flatPath": "v1/requestStatus:retrieve", "httpMethod": "GET", "id": "datamanager.requestStatus.retrieve", "parameterOrder": [], "parameters": { "requestId": { -"description": "Required. Required. The request ID of the Data Manager API request.", "location": "query", "type": "string" } @@ -860,15 +820,13 @@ } } }, -"revision": "20260828", +"revision": "20260904", "rootUrl": "https://datamanager.googleapis.com/", "schemas": { "AdEvent": { -"description": "An ad event.", "id": "AdEvent", "properties": { "adFormat": { -"description": "Enum value for ad format.", "enum": [ "AD_FORMAT_UNSPECIFIED", "AD_FORMAT_AR", @@ -891,47 +849,42 @@ "AD_FORMAT_VIDEO" ], "enumDescriptions": [ -"Unspecified ad format.", -"AR ad.", -"Audio ad.", -"Banner ad.", -"Bumper ad.", -"Carousel ad.", -"Collection ad.", -"Image ad.", -"Interactive ad.", -"Interstitial ad.", -"In-feed ad.", -"In-stream ad.", -"In-stream skippable ad.", -"In-stream non-skippable ad.", -"Native ad.", -"Shorts ad.", -"Story ad.", -"Sponsored ad.", -"Video ad." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "adFormatString": { -"description": "String value for ad format.", "type": "string" }, "adGroupId": { -"description": "Optional. The ID of the associated ad group.", "type": "string" }, "adHeight": { -"description": "Optional. The height of the ad in pixels.", "format": "int32", "type": "integer" }, "adId": { -"description": "Optional. The ID of the associated ad within the group.", "type": "string" }, "adPlacement": { -"description": "Enum value for ad placement.", "enum": [ "AD_PLACEMENT_UNSPECIFIED", "AD_PLACEMENT_DISCOVER", @@ -945,25 +898,23 @@ "AD_PLACEMENT_STORY" ], "enumDescriptions": [ -"Unspecified ad placement.", -"Discover placement.", -"Feed placement.", -"Footer placement.", -"Header placement.", -"Home placement.", -"In-content placement.", -"Promoted placement.", -"Search placement.", -"Story placement." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "adPlacementString": { -"description": "String value for ad placement.", "type": "string" }, "adType": { -"description": "Enum value for ad type.", "enum": [ "AD_TYPE_UNSPECIFIED", "AD_TYPE_DISPLAY", @@ -975,62 +926,53 @@ "AD_TYPE_VIDEO" ], "enumDescriptions": [ -"Unspecified ad type.", -"Display ad.", -"Text ad.", -"Image ad.", -"Rich media ad.", -"HTML ad.", -"Audio ad.", -"Video ad." +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "adTypeString": { -"description": "String value for ad type.", "type": "string" }, "adWidth": { -"description": "Optional. The width of the ad in pixels.", "format": "int32", "type": "integer" }, "advertiserId": { -"description": "Required. The ID of the advertiser for the ad event. This must match the ID sent in the linking flow.", "type": "string" }, "attributionHint": { -"description": "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.", "enum": [ "ATTRIBUTION_HINT_UNSPECIFIED", "ATTRIBUTION_HINT_CONVERTED", "ATTRIBUTION_HINT_NOT_CONVERTED" ], "enumDescriptions": [ -"Unknown attribution status.", -"Converted status.", -"Not converted status." +"", +"", +"" ], "type": "string" }, "campaignId": { -"description": "Required. The ID of the associated campaign.", "type": "string" }, "campaignName": { -"description": "Required. The name of the associated campaign.", "type": "string" }, "deviceInfo": { -"$ref": "DeviceInfo", -"description": "Required. Information gathered about the device being used when the ad event happened." +"$ref": "DeviceInfo" }, "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.", "type": "string" }, "eventSubtype": { -"description": "Enum value for event subtype.", "enum": [ "EVENT_SUBTYPE_UNSPECIFIED", "EVENT_SUBTYPE_IMPRESSION", @@ -1039,46 +981,43 @@ "EVENT_SUBTYPE_OUTBOUND_CLICK" ], "enumDescriptions": [ -"Unspecified event subtype.", -"Impression event.", -"Engaged view event.", -"Onsite click event.", -"Outbound click event." +"", +"", +"", +"", +"" ], "type": "string" }, "eventSubtypeString": { -"description": "String value for event subtype.", "type": "string" }, "eventType": { -"description": "Required. The type of the event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", "EVENT_TYPE_VIEW", "EVENT_TYPE_CLICK" ], "enumDescriptions": [ -"Unspecified event type.", -"View event.", -"Click event." +"", +"", +"" ], "type": "string" }, +"ipAddress": { +"type": "string" +}, "measurementAllowed": { -"description": "Optional. Represents if the row is allowed to be used for measurement purposes, as governed by applicable privacy laws within regional jurisdiction.", "type": "boolean" }, "medium": { -"description": "Required. The medium of the ad, akin to the Google Analytics medium.", "type": "string" }, "mobileDeviceId": { -"description": "Optional. The device ID of the device that the ad was served to.", "type": "string" }, "platform": { -"description": "Enum value for platform.", "enum": [ "PLATFORM_UNSPECIFIED", "PLATFORM_IOS", @@ -1086,19 +1025,17 @@ "PLATFORM_WEB" ], "enumDescriptions": [ -"Unspecified platform.", -"iOS platform.", -"Android platform.", -"Web platform." +"", +"", +"", +"" ], "type": "string" }, "platformString": { -"description": "String value for platform.", "type": "string" }, "platformType": { -"description": "Enum value for platform type.", "enum": [ "PLATFORM_TYPE_UNSPECIFIED", "PLATFORM_TYPE_MOBILE", @@ -1108,29 +1045,25 @@ "PLATFORM_TYPE_TABLET" ], "enumDescriptions": [ -"Unspecified platform type.", -"Mobile platform.", -"Desktop platform.", -"CTV platform.", -"Phone platform.", -"Tablet platform." +"", +"", +"", +"", +"", +"" ], "type": "string" }, "platformTypeString": { -"description": "String value for platform type.", "type": "string" }, "regionCode": { -"description": "Optional. The ISO 3166-2 country plus subdivision.", "type": "string" }, "source": { -"description": "Required. The platform source of the ad, akin to the Google Analytics source.", "type": "string" }, "targetingType": { -"description": "Enum value for targeting type.", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_AUDIENCE", @@ -1143,251 +1076,208 @@ "TARGETING_TYPE_REMARKETING" ], "enumDescriptions": [ -"Unspecified targeting type.", -"Audience targeting.", -"Contextual targeting.", -"Demographic targeting.", -"Device targeting.", -"Geo targeting.", -"Interest targeting.", -"Purchase intent targeting.", -"Remarketing targeting." +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "targetingTypeString": { -"description": "String value for targeting type.", "type": "string" }, "timestamp": { -"description": "Required. The time the event occurred.", "format": "google-datetime", "type": "string" }, "userData": { -"$ref": "UserData", -"description": "Optional. Multiple pieces of user-provided data, representing the user the event is associated with. It is possible to provide multiple instances of the same type of data (e.g. email address). The more data provided, the more likely a match will be found." +"$ref": "UserData" }, "viewabilityInfo": { -"$ref": "ViewabilityInfo", -"description": "Required. Details of the viewability of the ad served." +"$ref": "ViewabilityInfo" } }, "type": "object" }, "AdIdentifiers": { -"description": "Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).", "id": "AdIdentifiers", "properties": { "dclid": { -"description": "Optional. The display click ID associated with this event.", "type": "string" }, "encryptedUserIds": { -"description": "Optional. Any number of encrypted user IDs.", "items": { "$ref": "EncryptedUserId" }, "type": "array" }, "gbraid": { -"description": "Optional. The click identifier for clicks associated with app events and originating from iOS devices starting with iOS14.", "type": "string" }, "gclid": { -"description": "Optional. The Google click ID (gclid) associated with this event.", "type": "string" }, "impressionId": { -"description": "Optional. The impression ID associated with this event.", "type": "string" }, "landingPageDeviceInfo": { -"$ref": "DeviceInfo", -"description": "Optional. Information gathered about the device being used (if any) at the time of landing onto the advertiser\u2019s site after interacting with the ad." +"$ref": "DeviceInfo" }, "matchId": { -"description": "Optional. The match ID field used to join this event with a previous event.", "type": "string" }, "mobileDeviceId": { -"description": "Optional. The mobile identifier for advertisers. This would be IDFA on iOS, AdID on Android, or other platforms\u2019 identifiers for advertisers.", +"type": "string" +}, +"ppid": { "type": "string" }, "sessionAttributes": { -"description": "Optional. Session attributes for event attribution and modeling.", +"type": "string" +}, +"visitorPpid": { "type": "string" }, "wbraid": { -"description": "Optional. The click identifier for clicks associated with web events and originating from iOS devices starting with iOS14.", "type": "string" } }, "type": "object" }, "AddressInfo": { -"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" }, "givenName": { -"description": "Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.", "type": "string" }, "postalCode": { -"description": "Required. The postal code of the user's address.", "type": "string" }, "regionCode": { -"description": "Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.", "type": "string" } }, "type": "object" }, "AudienceMember": { -"description": "The audience member to be operated on.", "id": "AudienceMember", "properties": { "compositeData": { -"$ref": "CompositeData", -"description": "Group of multiple identifier types." +"$ref": "CompositeData" }, "consent": { -"$ref": "Consent", -"description": "Optional. The consent setting for the user." +"$ref": "Consent" }, "destinationReferences": { -"description": "Optional. Defines which Destination to send the audience member to.", "items": { "type": "string" }, "type": "array" }, "googleUserIdData": { -"$ref": "GoogleUserIdData", -"description": "Encrypted Google User IDs." +"$ref": "GoogleUserIdData" }, "mobileData": { -"$ref": "MobileData", -"description": "Data identifying the user's mobile devices." +"$ref": "MobileData" }, "pairData": { -"$ref": "PairData", -"description": "[Publisher Advertiser Identity Reconciliation (PAIR) IDs](//support.google.com/admanager/answer/15067908). This feature is only available to data partners." +"$ref": "PairData" }, "partnerProvidedIdData": { -"$ref": "PartnerProvidedIdData", -"description": "Partner-provided identifiers." +"$ref": "PartnerProvidedIdData" }, "ppidData": { -"$ref": "PpidData", -"description": "Data related to publisher provided identifiers. This feature is only available to data partners." +"$ref": "PpidData" }, "userData": { -"$ref": "UserData", -"description": "User-provided data that identifies the user." +"$ref": "UserData" }, "userIdData": { -"$ref": "UserIdData", -"description": "Data related to unique identifiers for a user, as defined by the advertiser." +"$ref": "UserIdData" } }, "type": "object" }, "AwsWrappedKeyInfo": { -"description": "A data encryption key wrapped by an AWS KMS key.", "id": "AwsWrappedKeyInfo", "properties": { "encryptedDek": { -"description": "Required. The base64 encoded encrypted data encryption key.", "type": "string" }, "kekUri": { -"description": "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}`", "type": "string" }, "keyType": { -"description": "Required. The type of algorithm used to encrypt the data.", "enum": [ "KEY_TYPE_UNSPECIFIED", "XCHACHA20_POLY1305" ], "enumDescriptions": [ -"Unspecified key type. Should never be used.", -"Algorithm XChaCha20-Poly1305" +"", +"" ], "type": "string" }, "roleArn": { -"description": "Required. The Amazon Resource Name of the IAM Role to assume for KMS decryption access. Should be in the format of `arn:{partition}:iam::{account_id}:role/{role_name}`", "type": "string" } }, "type": "object" }, "Baseline": { -"description": "Baseline criteria against which insights are compared.", "id": "Baseline", "properties": { "baselineLocation": { -"$ref": "Location", -"description": "The baseline location of the request. Baseline location is an OR-list of the requested regions." +"$ref": "Location" }, "locationAutoDetectionEnabled": { -"description": "If set to true, the service will try to automatically detect the baseline location for insights.", "type": "boolean" } }, "type": "object" }, "CartData": { -"description": "The cart data associated with the event.", "id": "CartData", "properties": { "couponCodes": { -"description": "Optional. The list of coupon codes that were applied to the cart. Cart-level and item-level coupon codes are independent. If the event is for a Google Analytics destination, only provide a single coupon code. Google Analytics ignores additional coupon codes.", "items": { "type": "string" }, "type": "array" }, "items": { -"description": "Optional. The list of items associated with the event.", "items": { "$ref": "Item" }, "type": "array" }, "merchantFeedLabel": { -"description": "Optional. The Merchant Center feed label associated with the feed of the items.", "type": "string" }, "merchantFeedLanguageCode": { -"description": "Optional. The language code in ISO 639-1 associated with the Merchant Center feed of the items.where your items are uploaded.", "type": "string" }, "merchantId": { -"description": "Optional. The Merchant Center ID associated with the items.", "type": "string" }, "transactionDiscount": { -"description": "Optional. The sum of all discounts associated with the transaction.", "format": "double", "type": "number" } @@ -1395,52 +1285,46 @@ "type": "object" }, "CompositeData": { -"description": "Composite data holding identifiers and associated data for a user. At least one of `user_data` or `ip_data` is required.", "id": "CompositeData", "properties": { "ipData": { -"description": "Optional. IP address data representing customer interaction used to build the audience.", "items": { "$ref": "IpData" }, "type": "array" }, "userData": { -"$ref": "UserData", -"description": "Optional. User-provided data that identifies the user." +"$ref": "UserData" } }, "type": "object" }, "Consent": { -"description": "[Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user.", "id": "Consent", "properties": { "adPersonalization": { -"description": "Optional. Represents if the user consents to ad personalization.", "enum": [ "CONSENT_STATUS_UNSPECIFIED", "CONSENT_GRANTED", "CONSENT_DENIED" ], "enumDescriptions": [ -"Not specified.", -"Granted.", -"Denied." +"", +"", +"" ], "type": "string" }, "adUserData": { -"description": "Optional. Represents if the user consents to ad user data.", "enum": [ "CONSENT_STATUS_UNSPECIFIED", "CONSENT_GRANTED", "CONSENT_DENIED" ], "enumDescriptions": [ -"Not specified.", -"Granted.", -"Denied." +"", +"", +"" ], "type": "string" } @@ -1448,11 +1332,9 @@ "type": "object" }, "ContactIdInfo": { -"description": "Additional information when `CONTACT_ID` is one of the `upload_key_types`.", "id": "ContactIdInfo", "properties": { "dataSourceType": { -"description": "Optional. Immutable. Source of the upload data", "enum": [ "DATA_SOURCE_TYPE_UNSPECIFIED", "DATA_SOURCE_TYPE_FIRST_PARTY", @@ -1461,16 +1343,15 @@ "DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA" ], "enumDescriptions": [ -"Not specified.", -"The uploaded data is first-party data.", -"The uploaded data is from a third-party credit bureau.", -"The uploaded data is from a third-party voter file.", -"The uploaded data is third party partner data." +"", +"", +"", +"", +"" ], "type": "string" }, "matchRatePercentage": { -"description": "Output only. Match rate for customer match user lists.", "format": "int32", "readOnly": true, "type": "integer" @@ -1479,49 +1360,40 @@ "type": "object" }, "CoordinatorKeyInfo": { -"description": "Information about the coordinator key.", "id": "CoordinatorKeyInfo", "properties": { "keyId": { -"description": "Required. The ID of the chosen coordinator key.", "type": "string" } }, "type": "object" }, "CustomVariable": { -"description": "Custom variable for ads conversions.", "id": "CustomVariable", "properties": { "destinationReferences": { -"description": "Optional. Reference string used to determine which of the Event.destination_references the custom variable should be sent to. If empty, the Event.destination_references will be used.", "items": { "type": "string" }, "type": "array" }, "value": { -"description": "Optional. The value to store for the custom variable.", "type": "string" }, "variable": { -"description": "Optional. The name of the custom variable to set. If the variable is not found for the given destination, it will be ignored.", "type": "string" } }, "type": "object" }, "DataTypeCount": { -"description": "The count for a specific data type.", "id": "DataTypeCount", "properties": { "count": { -"description": "The count for this data type.", "format": "int64", "type": "string" }, "type": { -"description": "The type of data.", "enum": [ "DATA_TYPE_UNSPECIFIED", "EMAIL", @@ -1530,11 +1402,11 @@ "IP_ADDRESS" ], "enumDescriptions": [ -"The data type is unspecified.", -"The data is an email address.", -"The data is a phone number.", -"The data is a physical address.", -"The data is an IP address." +"", +"", +"", +"", +"" ], "type": "string" } @@ -1542,110 +1414,86 @@ "type": "object" }, "Destination": { -"description": "The Google product you're sending data to. For example, a Google Ads account.", "id": "Destination", "properties": { "linkedAccount": { -"$ref": "ProductAccount", -"description": "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`." +"$ref": "ProductAccount" }, "loginAccount": { -"$ref": "ProductAccount", -"description": "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`." +"$ref": "ProductAccount" }, "operatingAccount": { -"$ref": "ProductAccount", -"description": "Required. The account to send the data to or remove the data from." +"$ref": "ProductAccount" }, "productDestinationId": { -"description": "Optional. 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. This field is optional for Google Ad Manager event ingestion and User ingestion. Required for all other use cases.", "type": "string" }, "reference": { -"description": "Optional. ID for this `Destination` resource, unique within the request. Use to reference this `Destination` in the IngestEventsRequest and IngestAudienceMembersRequest.", "type": "string" } }, "type": "object" }, "DeviceInfo": { -"description": "Information about the device being used (if any) when the event happened.", "id": "DeviceInfo", "properties": { "brand": { -"description": "Optional. The brand of the device.", "type": "string" }, "browser": { -"description": "Optional. The brand or type of the browser.", "type": "string" }, "browserVersion": { -"description": "Optional. The version of the browser.", "type": "string" }, "category": { -"description": "Optional. The category of device. For example, \u201cdesktop\u201d, \u201ctablet\u201d, \u201cmobile\u201d, \u201csmart TV\u201d.", "type": "string" }, "ipAddress": { -"description": "Optional. The IP address of the device for the given context. Required when used in an AdEvent.", "type": "string" }, "languageCode": { -"description": "Optional. The language the device uses in ISO 639-1 format.", "type": "string" }, "model": { -"description": "Optional. The model of the device.", "type": "string" }, "operatingSystem": { -"description": "Optional. The operating system or platform of the device.", "type": "string" }, "operatingSystemVersion": { -"description": "Optional. The version of the operating system or platform.", "type": "string" }, "screenHeight": { -"description": "Optional. The height of the screen in pixels.", "format": "int32", "type": "integer" }, "screenWidth": { -"description": "Optional. The width of the screen in pixels.", "format": "int32", "type": "integer" }, "userAgent": { -"description": "Optional. The user-agent string of the device for the given context.", "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" }, "EncryptedUserId": { -"description": "A user identifier issued to be used for attribution. All fields are required if this is used.", "id": "EncryptedUserId", "properties": { "encryptedId": { -"description": "Required. The alphanumeric encrypted id.", "type": "string" }, "entityId": { -"description": "Required. The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.", "format": "int64", "type": "string" }, "entityType": { -"description": "Required. The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.", "enum": [ "ENCRYPTION_ENTITY_TYPE_UNSPECIFIED", "CAMPAIGN_MANAGER_ACCOUNT", @@ -1656,27 +1504,26 @@ "GOOGLE_AD_MANAGER_NETWORK_CODE" ], "enumDescriptions": [ -"Unspecified encryption entity type.", -"Campaign Manager 360 account.", -"Campaign Manager 360 advertiser.", -"Display & Video 360 partner.", -"Display & Video 360 advertiser.", -"Google Ads customer.", -"Google Ad Manager network code." +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "source": { -"description": "Required. Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.", "enum": [ "ENCRYPTION_SOURCE_UNSPECIFIED", "AD_SERVING", "DATA_TRANSFER" ], "enumDescriptions": [ -"Unspecified encryption source.", -"Ad serving encryption source.", -"Data transfer encryption source." +"", +"", +"" ], "type": "string" } @@ -1684,30 +1531,24 @@ "type": "object" }, "EncryptionInfo": { -"description": "Encryption information for the data being ingested.", "id": "EncryptionInfo", "properties": { "awsWrappedKeyInfo": { -"$ref": "AwsWrappedKeyInfo", -"description": "Amazon Web Services wrapped key information." +"$ref": "AwsWrappedKeyInfo" }, "coordinatorKeyInfo": { -"$ref": "CoordinatorKeyInfo", -"description": "Key information for the chosen coordinator key. This is not supported for the IngestEvents, IngestAudienceMembers, and RemoveAudienceMembers methods." +"$ref": "CoordinatorKeyInfo" }, "gcpWrappedKeyInfo": { -"$ref": "GcpWrappedKeyInfo", -"description": "Google Cloud Platform wrapped key information." +"$ref": "GcpWrappedKeyInfo" } }, "type": "object" }, "ErrorCount": { -"description": "The error count for a given error reason.", "id": "ErrorCount", "properties": { "reason": { -"description": "The error reason of the failed records.", "enum": [ "PROCESSING_ERROR_REASON_UNSPECIFIED", "PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE", @@ -1756,56 +1597,55 @@ "PROCESSING_ERROR_REASON_EXTERNAL_ATTRIBUTION_DATA_MISSING" ], "enumDescriptions": [ -"The processing error reason is unknown.", -"The custom variable is invalid.", -"The status of the custom variable is not enabled.", -"The conversion is older than max supported age.", -"The ad user data is denied, either by the user or in the advertiser default settings.", -"Advertiser did not give 3P consent for the Ads core platform services.", -"The overall consent (determined from row level consent, request level consent, and account settings) could not be determined for this user", -"A conversion with the same GCLID and conversion time already exists in the system.", -"A conversion with the same order id and conversion action combination was already uploaded.", -"The gbraid could not be decoded.", -"The google click ID could not be decoded.", -"Merchant id contains non-digit characters.", -"The wbraid could not be decoded.", -"Internal error.", -"Enhanced conversions terms are not signed in the destination account.", -"The event is invalid.", -"The matched transactions are less than the minimum threshold.", -"The transactions are less than the minimum threshold.", -"The event has format error.", -"The event has a decryption error.", -"The DEK failed to be decrypted.", -"The WIP is formatted incorrectly or the WIP does not exist.", -"The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.", -"The WIP could not be used because it was rejected by its attestation condition.", -"The system did not have the permissions needed to access the KEK.", -"The system failed to authenticate with AWS.", -"Failed to decrypt the UserIdentifier data using the DEK.", -"The user attempted to ingest events with an ad identifier that isn't from the operating account's ads.", -"One-per-click conversion actions cannot be used with BRAIDs.", -"The match ID can not be found.", -"The user ID can not be found for the match ID.", -"The user ID can not be found for the GCLID.", -"The user ID can not be found for the DCLID.", -"There are ad identifiers that are invalid.", -"The mobile ID format is invalid.", -"The original conversions can't be found.", -"The event ID (dclid or impression ID) cannot be decoded.", -"The user ID cannot be found for the given impression ID.", -"The user ID cannot be found.", -"The event timestamp on the event was earlier than the associated click.", -"The click occurred too recently.", -"The event can't be attributed to a click (GCLID). This may be because the click did not come from a Google Ads campaign, for example.", -"The click from the event isn't associated with the `operating_account` of the destination.", -"A corresponding click can't be found that matches the provided attributes.", -"External attribution data is missing. Sending events to a destination for an external attribution conversion action isn't supported." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "recordCount": { -"description": "The count of records that failed to upload for a given reason.", "format": "int64", "type": "string" } @@ -1813,11 +1653,9 @@ "type": "object" }, "ErrorInfo": { -"description": "Error counts for each type of error.", "id": "ErrorInfo", "properties": { "errorCounts": { -"description": "A list of errors and counts per error reason. May not be populated in all cases.", "items": { "$ref": "ErrorCount" }, @@ -1827,78 +1665,62 @@ "type": "object" }, "Event": { -"description": "An event representing a user interaction with an advertiser's website or app.", "id": "Event", "properties": { "adIdentifiers": { -"$ref": "AdIdentifiers", -"description": "Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks)." +"$ref": "AdIdentifiers" }, "additionalEventParameters": { -"description": "Optional. A bucket of any [event parameters](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.", "items": { "$ref": "EventParameter" }, "type": "array" }, "appInstanceId": { -"description": "Optional. A unique identifier for the user instance of an app client for this GA4 app stream.", "type": "string" }, "cartData": { -"$ref": "CartData", -"description": "Optional. Information about the transaction and items associated with the event." +"$ref": "CartData" }, "clientId": { -"description": "Optional. A unique identifier for the user instance of a web client for this GA4 web stream.", "type": "string" }, "consent": { -"$ref": "Consent", -"description": "Optional. Information about whether the associated user has provided different types of consent." +"$ref": "Consent" }, "conversionCount": { -"description": "Optional. The conversion quantity associated with the event, for counting-based conversions.", "format": "double", "type": "number" }, "conversionValue": { -"description": "Optional. The conversion value associated with the event, for value-based conversions.", "format": "double", "type": "number" }, "currency": { -"description": "Optional. The currency code associated with all monetary values within this event.", "type": "string" }, "customVariables": { -"description": "Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).", "items": { "$ref": "CustomVariable" }, "type": "array" }, "destinationReferences": { -"description": "Optional. Reference string used to determine the destination. If empty, the event will be sent to all destinations in the request.", "items": { "type": "string" }, "type": "array" }, "eventDeviceInfo": { -"$ref": "DeviceInfo", -"description": "Optional. Information gathered about the device being used (if any) when the event happened." +"$ref": "DeviceInfo" }, "eventLocation": { -"$ref": "EventLocation", -"description": "Optional. Information gathered about the location of the user when this event occurred." +"$ref": "EventLocation" }, "eventName": { -"description": "Optional. The name of the event. Required for GA4 events.", "type": "string" }, "eventSource": { -"description": "Optional. Signal for where the event happened (web, app, in-store, etc.).", "enum": [ "EVENT_SOURCE_UNSPECIFIED", "WEB", @@ -1909,131 +1731,106 @@ "OTHER" ], "enumDescriptions": [ -"Unspecified EventSource. Should never be used.", -"The event was generated from a web browser.", -"The event was generated from an app.", -"The event was generated from an in-store transaction.", -"The event was generated from a phone call.", -"The event was generated from a message.", -"The event was generated from other sources." +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "eventTimestamp": { -"description": "Required. The time the event occurred.", "format": "google-datetime", "type": "string" }, "experimentalFields": { -"description": "Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.", "items": { "$ref": "ExperimentalField" }, "type": "array" }, "lastUpdatedTimestamp": { -"description": "Optional. The last time the event was updated.", "format": "google-datetime", "type": "string" }, "thirdPartyUserData": { -"$ref": "UserData", -"description": "Optional. The same type of data provided in user_data, but explicitly flagged as being provided as owned by a third-party and not first-party advertiser data." +"$ref": "UserData" }, "transactionId": { -"description": "Optional. The unique identifier for this event. Required for events sent as an additional data source for tag conversions.", "type": "string" }, "userData": { -"$ref": "UserData", -"description": "Optional. Pieces of user provided data, representing the user the event is associated with." +"$ref": "UserData" }, "userId": { -"description": "Optional. A unique identifier for a user, as defined by the advertiser.", "type": "string" }, "userProperties": { -"$ref": "UserProperties", -"description": "Optional. Advertiser-assessed information about the user at the time that the event happened." +"$ref": "UserProperties" } }, "type": "object" }, "EventLocation": { -"description": "The location where the event occurred.", "id": "EventLocation", "properties": { "city": { -"description": "Optional. The name of the city where the event occurred.", "type": "string" }, "continentCode": { -"description": "Optional. The continent code in UN M49 format where the event occurred.", "type": "string" }, "regionCode": { -"description": "Optional. The 2-letter CLDR region code of the user's address.", "type": "string" }, "storeId": { -"description": "Optional. Required for Store Sales. The identifier to represent a physical store where the event happened.", "type": "string" }, "subcontinentCode": { -"description": "Optional. The subcontinent code in UN M49 format where the event occurred.", "type": "string" }, "subdivisionCode": { -"description": "Optional. The ISO 3166-2 subdivision code where the event occurred.", "type": "string" } }, "type": "object" }, "EventParameter": { -"description": "Event parameter for GA4 events.", "id": "EventParameter", "properties": { "parameterName": { -"description": "Required. The name of the parameter to use.", "type": "string" }, "value": { -"description": "Required. The string representation of the value of the parameter to set.", "type": "string" } }, "type": "object" }, "ExperimentalField": { -"description": "Experimental field representing unofficial fields.", "id": "ExperimentalField", "properties": { "field": { -"description": "Optional. The name of the field to use.", "type": "string" }, "value": { -"description": "Optional. The value the field to set.", "type": "string" } }, "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", @@ -2052,21 +1849,21 @@ "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" } @@ -2074,42 +1871,35 @@ "type": "object" }, "GcpWrappedKeyInfo": { -"description": "Information about the Google Cloud Platform wrapped key.", "id": "GcpWrappedKeyInfo", "properties": { "encryptedDek": { -"description": "Required. The base64 encoded encrypted data encryption key.", "type": "string" }, "kekUri": { -"description": "Required. Google Cloud Platform [Cloud Key Management Service resource ID](//cloud.google.com/kms/docs/getting-resource-ids). Should be in the format of `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}` or `gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}`", "type": "string" }, "keyType": { -"description": "Required. The type of algorithm used to encrypt the data.", "enum": [ "KEY_TYPE_UNSPECIFIED", "XCHACHA20_POLY1305" ], "enumDescriptions": [ -"Unspecified key type. Should never be used.", -"Algorithm XChaCha20-Poly1305" +"", +"" ], "type": "string" }, "wipProvider": { -"description": "Required. The [Workload Identity](//cloud.google.com/iam/docs/workload-identity-federation) pool provider required to use KEK.", "type": "string" } }, "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" }, @@ -2119,160 +1909,131 @@ "type": "object" }, "IngestAdEventsRequest": { -"description": "Request to upload ad events.", "id": "IngestAdEventsRequest", "properties": { "adEvents": { -"description": "Required. Required (at least 1). A list of ad events.", "items": { "$ref": "AdEvent" }, "type": "array" }, "encryptionInfo": { -"$ref": "EncryptionInfo", -"description": "Required. Information about encryption keys which are used to encrypt the data." +"$ref": "EncryptionInfo" }, "validateOnly": { "deprecated": true, -"description": "Optional. If true, the request is validated, but not executed.", "type": "boolean" } }, "type": "object" }, "IngestAdEventsResponse": { -"description": "Response from an ad event ingestion operation.", "id": "IngestAdEventsResponse", "properties": {}, "type": "object" }, "IngestAudienceMembersRequest": { -"description": "Request to upload audience members to the provided destinations. Returns an IngestAudienceMembersResponse.", "id": "IngestAudienceMembersRequest", "properties": { "audienceMembers": { -"description": "Required. The list of users to send to the specified destinations. At most 10000 AudienceMember resources can be sent in a single request.", "items": { "$ref": "AudienceMember" }, "type": "array" }, "consent": { -"$ref": "Consent", -"description": "Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each AudienceMember." +"$ref": "Consent" }, "destinations": { -"description": "Required. The list of destinations to send the audience members to.", "items": { "$ref": "Destination" }, "type": "array" }, "encoding": { -"description": "Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non `UserData` uploads, this field is ignored.", "enum": [ "ENCODING_UNSPECIFIED", "HEX", "BASE64" ], "enumDescriptions": [ -"Unspecified Encoding type. Should never be used.", -"Hex encoding.", -"Base 64 encoding." +"", +"", +"" ], "type": "string" }, "encryptionInfo": { -"$ref": "EncryptionInfo", -"description": "Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored." +"$ref": "EncryptionInfo" }, "termsOfService": { -"$ref": "TermsOfService", -"description": "Optional. The terms of service that the user has accepted/rejected." +"$ref": "TermsOfService" }, "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" }, "IngestAudienceMembersResponse": { -"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" } }, "type": "object" }, "IngestAudienceMembersStatus": { -"description": "The status of the ingest audience members request.", "id": "IngestAudienceMembersStatus", "properties": { "compositeDataIngestionStatus": { -"$ref": "IngestCompositeDataStatus", -"description": "The status of the composite data ingestion to the destination." +"$ref": "IngestCompositeDataStatus" }, "googleUserIdDataIngestionStatus": { -"$ref": "IngestGoogleUserIdDataStatus", -"description": "The status of the google user id data ingestion to the destination." +"$ref": "IngestGoogleUserIdDataStatus" }, "mobileDataIngestionStatus": { -"$ref": "IngestMobileDataStatus", -"description": "The status of the mobile data ingestion to the destination." +"$ref": "IngestMobileDataStatus" }, "pairDataIngestionStatus": { -"$ref": "IngestPairDataStatus", -"description": "The status of the pair data ingestion to the destination." +"$ref": "IngestPairDataStatus" }, "partnerProvidedIdDataIngestionStatus": { -"$ref": "IngestPartnerProvidedIdDataStatus", -"description": "The status of the partner provided id data ingestion to the destination." +"$ref": "IngestPartnerProvidedIdDataStatus" }, "ppidDataIngestionStatus": { -"$ref": "IngestPpidDataStatus", -"description": "The status of the ppid data ingestion to the destination." +"$ref": "IngestPpidDataStatus" }, "userDataIngestionStatus": { -"$ref": "IngestUserDataStatus", -"description": "The status of the user data ingestion to the destination." +"$ref": "IngestUserDataStatus" }, "userIdDataIngestionStatus": { -"$ref": "IngestUserIdDataStatus", -"description": "The status of the user id data ingestion to the destination." +"$ref": "IngestUserIdDataStatus" } }, "type": "object" }, "IngestCompositeDataStatus": { -"description": "The status of the composite data ingestion to the destination containing stats related to the ingestion.", "id": "IngestCompositeDataStatus", "properties": { "dataTypeCounts": { -"description": "The total count of data types sent in the upload request for the destination, broken down by data type. Includes all data types in the request, regardless of whether they were successfully ingested or not.", "items": { "$ref": "DataTypeCount" }, "type": "array" }, "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" }, "uploadMatchRateRange": { -"description": "The match rate range of the upload.", "enum": [ "MATCH_RATE_RANGE_UNKNOWN", "MATCH_RATE_RANGE_NOT_ELIGIBLE", @@ -2287,17 +2048,17 @@ "MATCH_RATE_RANGE_91_TO_100" ], "enumDescriptions": [ -"The match rate range is unknown.", -"The match rate range is not eligible.", -"The match rate range is less than 20% (in the interval `[0, 20)`).", -"The match rate range is between 20% and 30% (in the interval `[20, 31)`).", -"The match rate range is between 31% and 40% (in the interval `[31, 41)`).", -"The match rate range is between 41% and 50% (in the interval `[41, 51)`).", -"The match rate range is between 51% and 60% (in the interval `[51, 61)`.", -"The match rate range is between 61% and 70% (in the interval `[61, 71)`).", -"The match rate range is between 71% and 80% (in the interval `[71, 81)`).", -"The match rate range is between 81% and 90% (in the interval `[81, 91)`).", -"The match rate range is between 91% and 100% (in the interval `[91, 100]`)." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -2305,76 +2066,64 @@ "type": "object" }, "IngestEventsRequest": { -"description": "Request to upload audience members to the provided destinations. Returns an IngestEventsResponse.", "id": "IngestEventsRequest", "properties": { "consent": { -"$ref": "Consent", -"description": "Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each Event." +"$ref": "Consent" }, "destinations": { -"description": "Required. The list of destinations to send the events to.", "items": { "$ref": "Destination" }, "type": "array" }, "encoding": { -"description": "Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non `UserData` uploads, this field is ignored.", "enum": [ "ENCODING_UNSPECIFIED", "HEX", "BASE64" ], "enumDescriptions": [ -"Unspecified Encoding type. Should never be used.", -"Hex encoding.", -"Base 64 encoding." +"", +"", +"" ], "type": "string" }, "encryptionInfo": { -"$ref": "EncryptionInfo", -"description": "Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored." +"$ref": "EncryptionInfo" }, "events": { -"description": "Required. The list of events to send to the specified destinations. At most 2000 Event resources can be sent in a single request.", "items": { "$ref": "Event" }, "type": "array" }, "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" }, "IngestEventsResponse": { -"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" } }, "type": "object" }, "IngestEventsStatus": { -"description": "The status of the events ingestion to the destination.", "id": "IngestEventsStatus", "properties": { "recordCount": { -"description": "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.", "format": "int64", "type": "string" } @@ -2382,16 +2131,13 @@ "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" } @@ -2399,16 +2145,13 @@ "type": "object" }, "IngestMobileDataStatus": { -"description": "The status of the mobile data ingestion to the destination containing stats related to the ingestion.", "id": "IngestMobileDataStatus", "properties": { "mobileIdCount": { -"description": "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.", "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" } @@ -2416,16 +2159,13 @@ "type": "object" }, "IngestPairDataStatus": { -"description": "The status of the pair data ingestion to the destination containing stats related to the ingestion.", "id": "IngestPairDataStatus", "properties": { "pairIdCount": { -"description": "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.", "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" } @@ -2433,16 +2173,13 @@ "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" } @@ -2450,16 +2187,13 @@ "type": "object" }, "IngestPpidDataStatus": { -"description": "The status of the ppid data ingestion to the destination containing stats related to the ingestion.", "id": "IngestPpidDataStatus", "properties": { "ppidCount": { -"description": "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.", "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" } @@ -2467,16 +2201,13 @@ "type": "object" }, "IngestUserDataStatus": { -"description": "The status of the user data ingestion to the destination containing stats related to the ingestion.", "id": "IngestUserDataStatus", "properties": { "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" }, "uploadMatchRateRange": { -"description": "The match rate range of the upload.", "enum": [ "MATCH_RATE_RANGE_UNKNOWN", "MATCH_RATE_RANGE_NOT_ELIGIBLE", @@ -2491,22 +2222,21 @@ "MATCH_RATE_RANGE_91_TO_100" ], "enumDescriptions": [ -"The match rate range is unknown.", -"The match rate range is not eligible.", -"The match rate range is less than 20% (in the interval `[0, 20)`).", -"The match rate range is between 20% and 30% (in the interval `[20, 31)`).", -"The match rate range is between 31% and 40% (in the interval `[31, 41)`).", -"The match rate range is between 41% and 50% (in the interval `[41, 51)`).", -"The match rate range is between 51% and 60% (in the interval `[51, 61)`.", -"The match rate range is between 61% and 70% (in the interval `[61, 71)`).", -"The match rate range is between 71% and 80% (in the interval `[71, 81)`).", -"The match rate range is between 81% and 90% (in the interval `[81, 91)`).", -"The match rate range is between 91% and 100% (in the interval `[91, 100]`)." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "userIdentifierCount": { -"description": "The total count of user identifiers sent in the upload request for the destination. Includes all user identifiers in the request, regardless of whether they were successfully ingested or not.", "format": "int64", "type": "string" } @@ -2514,16 +2244,13 @@ "type": "object" }, "IngestUserIdDataStatus": { -"description": "The status of the user id data ingestion to the destination containing stats related to the ingestion.", "id": "IngestUserIdDataStatus", "properties": { "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" }, "userIdCount": { -"description": "The total count of user ids sent in the upload request for the destination. Includes all user ids in the request, regardless of whether they were successfully ingested or not.", "format": "int64", "type": "string" } @@ -2531,31 +2258,24 @@ "type": "object" }, "IngestedUserListInfo": { -"description": "Represents a user list that is populated by user provided data.", "id": "IngestedUserListInfo", "properties": { "contactIdInfo": { -"$ref": "ContactIdInfo", -"description": "Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`." +"$ref": "ContactIdInfo" }, "mobileIdInfo": { -"$ref": "MobileIdInfo", -"description": "Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`." +"$ref": "MobileIdInfo" }, "pairIdInfo": { -"$ref": "PairIdInfo", -"description": "Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners." +"$ref": "PairIdInfo" }, "partnerAudienceInfo": { -"$ref": "PartnerAudienceInfo", -"description": "Optional. Additional information for partner audiences. This feature is only available to data partners." +"$ref": "PartnerAudienceInfo" }, "pseudonymousIdInfo": { -"$ref": "PseudonymousIdInfo", -"description": "Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`." +"$ref": "PseudonymousIdInfo" }, "uploadKeyTypes": { -"description": "Required. Immutable. Upload key types of this user list.", "items": { "enum": [ "UPLOAD_KEY_TYPE_UNSPECIFIED", @@ -2566,39 +2286,34 @@ "PSEUDONYMOUS_ID" ], "enumDescriptions": [ -"Not specified.", -"Customer info such as email address, phone number or physical address.", -"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 - Generic Device ID" +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "userIdInfo": { -"$ref": "UserIdInfo", -"description": "Optional. Additional information when `USER_ID` is one of the `upload_key_types`." +"$ref": "UserIdInfo" } }, "type": "object" }, "IpData": { -"description": "IP address information for a user. We recommend including observe_start_time and observe_end_time to help improve Customer Match match rates.", "id": "IpData", "properties": { "ipAddress": { -"description": "Required. IP address captured at the time of customer interaction. Accepts standard string formats for both IPv4 and IPv6.", "type": "string" }, "observeEndTime": { -"description": "Optional. Last recorded interaction time from this IP address in a session.", "format": "google-datetime", "type": "string" }, "observeStartTime": { -"description": "Optional. First recorded interaction time from this IP address in a session.", "format": "google-datetime", "type": "string" } @@ -2606,55 +2321,44 @@ "type": "object" }, "Item": { -"description": "Represents an item in the cart associated with the event.", "id": "Item", "properties": { "additionalItemParameters": { -"description": "Optional. A bucket of any [event parameters related to an item](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.", "items": { "$ref": "ItemParameter" }, "type": "array" }, "conversionValue": { -"description": "Optional. The conversion value associated with this item within the event, for cases where the conversion value is different for each item.", "format": "double", "type": "number" }, "customVariables": { -"description": "Optional. Additional key/value pair information to send to the conversion containers (conversion action or Floodlight activity), when tracking per-item conversions.", "items": { "$ref": "ItemCustomVariable" }, "type": "array" }, "itemId": { -"description": "Optional. A unique identifier to reference the item.", "type": "string" }, "merchantFeedLabel": { -"description": "Optional. The feed label of the Merchant Center feed. If countries are still being used, the 2-letter country code in ISO-3166-1 alpha-2 can be used instead. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.", "type": "string" }, "merchantFeedLanguageCode": { -"description": "Optional. The language code in ISO 639-1 associated with the Merchant Center feed where your items are uploaded.", "type": "string" }, "merchantId": { -"description": "Optional. The Merchant Center ID associated with the item. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.", "type": "string" }, "merchantProductId": { -"description": "Optional. The product ID within the Merchant Center account.", "type": "string" }, "quantity": { -"description": "Optional. The number of this item associated with the event.", "format": "int64", "type": "string" }, "unitPrice": { -"description": "Optional. The unit price excluding tax, shipping, and any transaction level discounts.", "format": "double", "type": "number" } @@ -2662,52 +2366,42 @@ "type": "object" }, "ItemCustomVariable": { -"description": "Item-level custom variable for ads conversions.", "id": "ItemCustomVariable", "properties": { "destinationReferences": { -"description": "Optional. Reference string used to determine which of the Event.destination_references the custom variable should be sent to. If empty, the Event.destination_references will be used.", "items": { "type": "string" }, "type": "array" }, "value": { -"description": "Optional. The value to store for the custom variable.", "type": "string" }, "variable": { -"description": "Optional. The name of the custom variable to set. If the variable is not found for the given destination, it will be ignored.", "type": "string" } }, "type": "object" }, "ItemParameter": { -"description": "A bucket of any [event parameters related to an item](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.", "id": "ItemParameter", "properties": { "parameterName": { -"description": "Required. The name of the parameter to use.", "type": "string" }, "value": { -"description": "Required. The string representation of the value of the parameter to set.", "type": "string" } }, "type": "object" }, "ListUserListDirectLicensesResponse": { -"description": "Response from the ListUserListDirectLicensesRequest.", "id": "ListUserListDirectLicensesResponse", "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" }, "userListDirectLicenses": { -"description": "The licenses for the given user list in the request.", "items": { "$ref": "UserListDirectLicense" }, @@ -2717,15 +2411,12 @@ "type": "object" }, "ListUserListGlobalLicenseCustomerInfosResponse": { -"description": "Response from the ListUserListGlobalLicensesCustomerInfoRequest.", "id": "ListUserListGlobalLicenseCustomerInfosResponse", "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" }, "userListGlobalLicenseCustomerInfos": { -"description": "The customer information for the given license in the request.", "items": { "$ref": "UserListGlobalLicenseCustomerInfo" }, @@ -2735,15 +2426,12 @@ "type": "object" }, "ListUserListGlobalLicensesResponse": { -"description": "Response from the ListUserListGlobalLicensesRequest.", "id": "ListUserListGlobalLicensesResponse", "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" }, "userListGlobalLicenses": { -"description": "The licenses for the given user list in the request.", "items": { "$ref": "UserListGlobalLicense" }, @@ -2753,15 +2441,12 @@ "type": "object" }, "ListUserListsResponse": { -"description": "Response message for ListUserLists.", "id": "ListUserListsResponse", "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" }, "userLists": { -"description": "The user lists from the specified account.", "items": { "$ref": "UserList" }, @@ -2771,11 +2456,9 @@ "type": "object" }, "Location": { -"description": "The baseline location of the request. Baseline location is on OR-list of ISO 3166-1 alpha-2 region codes of the requested regions.", "id": "Location", "properties": { "regionCodes": { -"description": "List of ISO 3166-1 alpha-2 region codes.", "items": { "type": "string" }, @@ -2785,18 +2468,15 @@ "type": "object" }, "MarketingDataInsight": { -"description": "Insights for marketing data. This feature is only available to data partners.", "id": "MarketingDataInsight", "properties": { "attributes": { -"description": "Insights for values of a given dimension.", "items": { "$ref": "MarketingDataInsightsAttribute" }, "type": "array" }, "dimension": { -"description": "The dimension to which the insight belongs.", "enum": [ "AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED", "AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN", @@ -2806,12 +2486,12 @@ "GENDER" ], "enumDescriptions": [ -"Not specified.", -"The value is unknown in this version.", -"An Affinity UserInterest.", -"An In-Market UserInterest.", -"An age range.", -"A gender." +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -2819,11 +2499,9 @@ "type": "object" }, "MarketingDataInsightsAttribute": { -"description": "Insights for a collection of related attributes of the same dimension.", "id": "MarketingDataInsightsAttribute", "properties": { "ageRange": { -"description": "Age range of the audience for which the lift is provided.", "enum": [ "AGE_RANGE_UNSPECIFIED", "AGE_RANGE_UNKNOWN", @@ -2835,19 +2513,18 @@ "AGE_RANGE_65_UP" ], "enumDescriptions": [ -"Not specified.", -"Unknown.", -"Between 18 and 24 years old.", -"Between 25 and 34 years old.", -"Between 35 and 44 years old.", -"Between 45 and 54 years old.", -"Between 55 and 64 years old.", -"65 years old and beyond." +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "gender": { -"description": "Gender of the audience for which the lift is provided.", "enum": [ "GENDER_UNSPECIFIED", "GENDER_UNKNOWN", @@ -2855,20 +2532,18 @@ "GENDER_FEMALE" ], "enumDescriptions": [ -"Not specified.", -"Unknown.", -"Male.", -"Female." +"", +"", +"", +"" ], "type": "string" }, "lift": { -"description": "Measure of lift that the audience has for the attribute value as compared to the baseline. Range [0-1].", "format": "float", "type": "number" }, "userInterestId": { -"description": "The user interest ID.", "format": "int64", "type": "string" } @@ -2876,11 +2551,9 @@ "type": "object" }, "MobileData": { -"description": "Mobile IDs for the audience. At least one mobile ID is required.", "id": "MobileData", "properties": { "mobileIds": { -"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" }, @@ -2890,15 +2563,12 @@ "type": "object" }, "MobileIdInfo": { -"description": "Additional information when `MOBILE_ID` is one of the `upload_key_types`.", "id": "MobileIdInfo", "properties": { "appId": { -"description": "Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.", "type": "string" }, "dataSourceType": { -"description": "Optional. Immutable. Source of the upload data.", "enum": [ "DATA_SOURCE_TYPE_UNSPECIFIED", "DATA_SOURCE_TYPE_FIRST_PARTY", @@ -2907,25 +2577,24 @@ "DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA" ], "enumDescriptions": [ -"Not specified.", -"The uploaded data is first-party data.", -"The uploaded data is from a third-party credit bureau.", -"The uploaded data is from a third-party voter file.", -"The uploaded data is third party partner data." +"", +"", +"", +"", +"" ], "type": "string" }, "keySpace": { -"description": "Required. Immutable. The key space of mobile IDs.", "enum": [ "KEY_SPACE_UNSPECIFIED", "IOS", "ANDROID" ], "enumDescriptions": [ -"Not specified.", -"The iOS keyspace.", -"The Android keyspace." +"", +"", +"" ], "type": "string" } @@ -2933,11 +2602,9 @@ "type": "object" }, "PairData": { -"description": "[PAIR](//support.google.com/admanager/answer/15067908) IDs for the audience. At least one PAIR ID is required. This feature is only available to data partners.", "id": "PairData", "properties": { "pairIds": { -"description": "Required. Cleanroom-provided PII data, hashed with SHA256, and encrypted with an EC commutative cipher using publisher key for the [PAIR]((//support.google.com/admanager/answer/15067908)) user list. At most 10 `pairIds` can be provided in a single AudienceMember.", "items": { "type": "string" }, @@ -2947,45 +2614,36 @@ "type": "object" }, "PairIdInfo": { -"description": "Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.", "id": "PairIdInfo", "properties": { "advertiserIdentifierCount": { -"description": "Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.", "format": "int64", "type": "string" }, "cleanRoomIdentifier": { -"description": "Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.", "type": "string" }, "matchRatePercentage": { -"description": "Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.", "format": "int32", "type": "integer" }, "publisherId": { -"description": "Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.", "format": "int64", "type": "string" }, "publisherName": { -"description": "Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.", "type": "string" } }, "type": "object" }, "PartnerAudienceInfo": { -"description": "Additional information for partner audiences. This feature is only available to data partners.", "id": "PartnerAudienceInfo", "properties": { "commercePartner": { -"description": "Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.", "type": "string" }, "partnerAudienceSource": { -"description": "Required. Immutable. The source of the partner audience.", "enum": [ "PARTNER_AUDIENCE_SOURCE_UNSPECIFIED", "COMMERCE_AUDIENCE", @@ -2993,10 +2651,10 @@ "AGENCY_PROVIDER_AUDIENCE" ], "enumDescriptions": [ -"Not specified.", -"Partner Audience source is commerce audience.", -"Partner Audience source is linear TV audience.", -"Partner Audience source is agency/provider audience." +"", +"", +"", +"" ], "type": "string" } @@ -3004,76 +2662,62 @@ "type": "object" }, "PartnerCustomerAccount": { -"description": "Represents a customer account in the partner's system.", "id": "PartnerCustomerAccount", "properties": { "accountId": { -"description": "Required. The identifier of the customer account in the partner's ID space.", "type": "string" }, "accountName": { -"description": "Optional. The name of the account.", "type": "string" }, "accountType": { -"description": "Optional. The type of the account. Can be used to distinguish between advertiser accounts and business level accounts, for example.", "type": "string" } }, "type": "object" }, "PartnerLink": { -"description": "A partner link between an owning account and a partner account.", "id": "PartnerLink", "properties": { "featureSet": { -"description": "Optional. Immutable. The set of features supported for the partner link. If not specified, the system behavior defaults to FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT.", "enum": [ "FEATURE_SET_UNSPECIFIED", "FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT", "FEATURE_SET_AD_EVENT_MANAGEMENT" ], "enumDescriptions": [ -"Unspecified feature set. If unspecified, the system behavior defaults to FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT.", -"Indicates a link used for audience and event management.", -"Indicates a link used for ad event management." +"", +"", +"" ], "type": "string" }, "name": { -"description": "Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}", "type": "string" }, "owningAccount": { -"$ref": "ProductAccount", -"description": "Required. The owning account granting access to the partner account." +"$ref": "ProductAccount" }, "partnerAccount": { -"$ref": "ProductAccount", -"description": "Required. The partner account granted access by the owning account." +"$ref": "ProductAccount" }, "partnerCustomerAccount": { -"$ref": "PartnerCustomerAccount", -"description": "Optional. The customer account in the partner system. This is required for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set." +"$ref": "PartnerCustomerAccount" }, "partnerLinkId": { -"description": "Output only. The partner link ID.", "readOnly": true, "type": "string" }, "partnerLinkMetadata": { -"$ref": "PartnerLinkMetadata", -"description": "Optional. Metadata associated with the partner link. This is optional and only accepted for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT." +"$ref": "PartnerLinkMetadata" } }, "type": "object" }, "PartnerLinkMetadata": { -"description": "Represents metadata associated with a partner link.", "id": "PartnerLinkMetadata", "properties": { "implicitAccounts": { -"description": "Optional. The list of implicit accounts.", "items": { "$ref": "PartnerCustomerAccount" }, @@ -3083,11 +2727,9 @@ "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" }, @@ -3097,11 +2739,9 @@ "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", "properties": { "ppids": { -"description": "Required. The list of publisher provided identifiers for a user.", "items": { "type": "string" }, @@ -3111,15 +2751,12 @@ "type": "object" }, "ProductAccount": { -"description": "Represents a specific account.", "id": "ProductAccount", "properties": { "accountId": { -"description": "Required. The ID of the account. For example, your Google Ads account ID.", "type": "string" }, "accountType": { -"description": "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.", "enum": [ "ACCOUNT_TYPE_UNSPECIFIED", "GOOGLE_ADS", @@ -3128,23 +2765,24 @@ "DATA_PARTNER", "GOOGLE_ANALYTICS_PROPERTY", "GOOGLE_AD_MANAGER_AUDIENCE_LINK", -"FLOODLIGHT_CONFIG" +"FLOODLIGHT_CONFIG", +"GOOGLE_AD_MANAGER" ], "enumDescriptions": [ -"Unspecified product. Should never be used.", -"Google Ads.", -"Display & Video 360 partner.", -"Display & Video 360 advertiser.", -"Data Partner.", -"Google Analytics.", -"Google Ad Manager audience link.", -"Floodlight configuration." +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "product": { "deprecated": true, -"description": "Deprecated. Use `account_type` instead.", "enum": [ "PRODUCT_UNSPECIFIED", "GOOGLE_ADS", @@ -3153,11 +2791,11 @@ "DATA_PARTNER" ], "enumDescriptions": [ -"Unspecified product. Should never be used.", -"Google Ads.", -"Display & Video 360 partner.", -"Display & Video 360 advertiser.", -"Data Partner." +"", +"", +"", +"", +"" ], "type": "string" } @@ -3165,16 +2803,13 @@ "type": "object" }, "PseudonymousIdInfo": { -"description": "Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`.", "id": "PseudonymousIdInfo", "properties": { "billableRecordCount": { -"description": "Optional. Immutable. The number of billable records (e.g. uploaded or matched).", "format": "int64", "type": "string" }, "syncStatus": { -"description": "Output only. Sync status of the user list.", "enum": [ "SYNC_STATUS_UNSPECIFIED", "CREATED", @@ -3182,10 +2817,10 @@ "FAILED" ], "enumDescriptions": [ -"Not specified.", -"The user list has been created as a placeholder. List contents and/or metadata are still being synced. The user list is not ready for use.", -"The user list is ready for use. Contents and cookies have been synced correctly.", -"An error has occurred syncing user list contents and/or metadata. The user list cannot be used." +"", +"", +"", +"" ], "readOnly": true, "type": "string" @@ -3194,151 +2829,124 @@ "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", "properties": { "audienceMembers": { -"description": "Required. The list of users to remove.", "items": { "$ref": "AudienceMember" }, "type": "array" }, "destinations": { -"description": "Required. The list of destinations to remove the users from.", "items": { "$ref": "Destination" }, "type": "array" }, "encoding": { -"description": "Optional. Required for UserData uploads. The encoding type of the user identifiers. Applies to only the outer encoding for encrypted user identifiers. For non `UserData` uploads, this field is ignored.", "enum": [ "ENCODING_UNSPECIFIED", "HEX", "BASE64" ], "enumDescriptions": [ -"Unspecified Encoding type. Should never be used.", -"Hex encoding.", -"Base 64 encoding." +"", +"", +"" ], "type": "string" }, "encryptionInfo": { -"$ref": "EncryptionInfo", -"description": "Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored." +"$ref": "EncryptionInfo" }, "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" }, "RemoveAudienceMembersResponse": { -"description": "Response from the RemoveAudienceMembersRequest.", "id": "RemoveAudienceMembersResponse", "properties": { "requestId": { -"description": "The auto-generated ID of the request.", "type": "string" } }, "type": "object" }, "RemoveAudienceMembersStatus": { -"description": "The status of the remove audience members request.", "id": "RemoveAudienceMembersStatus", "properties": { "compositeDataRemovalStatus": { -"$ref": "RemoveCompositeDataStatus", -"description": "The status of the composite data removal from the destination." +"$ref": "RemoveCompositeDataStatus" }, "googleUserIdDataRemovalStatus": { -"$ref": "RemoveGoogleUserIdDataStatus", -"description": "The status of the google user id data removal from the destination." +"$ref": "RemoveGoogleUserIdDataStatus" }, "mobileDataRemovalStatus": { -"$ref": "RemoveMobileDataStatus", -"description": "The status of the mobile data removal from the destination." +"$ref": "RemoveMobileDataStatus" }, "pairDataRemovalStatus": { -"$ref": "RemovePairDataStatus", -"description": "The status of the pair data removal from the destination." +"$ref": "RemovePairDataStatus" }, "partnerProvidedIdDataRemovalStatus": { -"$ref": "RemovePartnerProvidedIdDataStatus", -"description": "The status of the partner provided id data removal from the destination." +"$ref": "RemovePartnerProvidedIdDataStatus" }, "ppidDataRemovalStatus": { -"$ref": "RemovePpidDataStatus", -"description": "The status of the ppid data removal from the destination." +"$ref": "RemovePpidDataStatus" }, "userDataRemovalStatus": { -"$ref": "RemoveUserDataStatus", -"description": "The status of the user data removal from the destination." +"$ref": "RemoveUserDataStatus" }, "userIdDataRemovalStatus": { -"$ref": "RemoveUserIdDataStatus", -"description": "The status of the user id data removal from the destination." +"$ref": "RemoveUserIdDataStatus" } }, "type": "object" }, "RemoveCompositeDataStatus": { -"description": "The status of the composite data removal from the destination.", "id": "RemoveCompositeDataStatus", "properties": { "dataTypeCounts": { -"description": "The total count of data types sent in the removal request, broken down by data type. Includes all data types in the request, regardless of whether they were successfully removed or not.", "items": { "$ref": "DataTypeCount" }, "type": "array" }, "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" } @@ -3346,16 +2954,13 @@ "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" } @@ -3363,16 +2968,13 @@ "type": "object" }, "RemoveMobileDataStatus": { -"description": "The status of the mobile data removal from the destination.", "id": "RemoveMobileDataStatus", "properties": { "mobileIdCount": { -"description": "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.", "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" } @@ -3380,16 +2982,13 @@ "type": "object" }, "RemovePairDataStatus": { -"description": "The status of the pair data removal from the destination.", "id": "RemovePairDataStatus", "properties": { "pairIdCount": { -"description": "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.", "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" } @@ -3397,16 +2996,13 @@ "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" } @@ -3414,16 +3010,13 @@ "type": "object" }, "RemovePpidDataStatus": { -"description": "The status of the ppid data removal from the destination.", "id": "RemovePpidDataStatus", "properties": { "ppidCount": { -"description": "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.", "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" } @@ -3431,16 +3024,13 @@ "type": "object" }, "RemoveUserDataStatus": { -"description": "The status of the user data removal from the destination.", "id": "RemoveUserDataStatus", "properties": { "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" }, "userIdentifierCount": { -"description": "The total count of user identifiers sent in the removal request. Includes all user identifiers in the request, regardless of whether they were successfully removed or not.", "format": "int64", "type": "string" } @@ -3448,16 +3038,13 @@ "type": "object" }, "RemoveUserIdDataStatus": { -"description": "The status of the user id data removal from the destination.", "id": "RemoveUserIdDataStatus", "properties": { "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" }, "userIdCount": { -"description": "The total count of user ids sent in the removal request. Includes all user ids in the request, regardless of whether they were successfully removed or not.", "format": "int64", "type": "string" } @@ -3465,35 +3052,27 @@ "type": "object" }, "RequestStatusPerDestination": { -"description": "A request status per destination.", "id": "RequestStatusPerDestination", "properties": { "audienceMembersIngestionStatus": { -"$ref": "IngestAudienceMembersStatus", -"description": "The status of the ingest audience members request." +"$ref": "IngestAudienceMembersStatus" }, "audienceMembersRemovalStatus": { -"$ref": "RemoveAudienceMembersStatus", -"description": "The status of the remove audience members request." +"$ref": "RemoveAudienceMembersStatus" }, "destination": { -"$ref": "Destination", -"description": "A destination within a DM API request." +"$ref": "Destination" }, "errorInfo": { -"$ref": "ErrorInfo", -"description": "An error info error containing the error reason and error counts related to the upload. Only populated if the `request_status` is `FAILED` or `PARTIAL_SUCCESS`. This field isn't populated while the request has `request_status` of `PROCESSING`." +"$ref": "ErrorInfo" }, "eventsIngestionStatus": { -"$ref": "IngestEventsStatus", -"description": "The status of the ingest events request." +"$ref": "IngestEventsStatus" }, "removeAllAudienceMembersStatus": { -"$ref": "RemoveAllAudienceMembersStatus", -"description": "The status of the remove all audience members request." +"$ref": "RemoveAllAudienceMembersStatus" }, "requestStatus": { -"description": "The request status of the destination.", "enum": [ "REQUEST_STATUS_UNKNOWN", "SUCCESS", @@ -3502,42 +3081,36 @@ "PARTIAL_SUCCESS" ], "enumDescriptions": [ -"The request status is unknown.", -"Processing succeeded for all records without any errors. However, there may be warnings in the `warning_info` field.", -"The request is processing.", -"Processing failed for all records. Check the `error_info` field for error details, and check the `warning_info` field for warning details.", -"Processing completed successfully without errors for some records, but failed with errors for other records. Check the `error_info` field for error details, and check the `warning_info` field for warning details." +"", +"", +"", +"", +"" ], "type": "string" }, "warningInfo": { -"$ref": "WarningInfo", -"description": "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`." +"$ref": "WarningInfo" } }, "type": "object" }, "RetrieveInsightsRequest": { -"description": "Request message for DM API MarketingDataInsightsService.RetrieveInsights", "id": "RetrieveInsightsRequest", "properties": { "baseline": { -"$ref": "Baseline", -"description": "Required. Baseline for the insights requested." +"$ref": "Baseline" }, "userListId": { -"description": "Required. The user list ID for which insights are requested.", "type": "string" } }, "type": "object" }, "RetrieveInsightsResponse": { -"description": "Response message for DM API MarketingDataInsightsService.RetrieveInsights", "id": "RetrieveInsightsResponse", "properties": { "marketingDataInsights": { -"description": "Contains the insights for the marketing data.", "items": { "$ref": "MarketingDataInsight" }, @@ -3547,11 +3120,9 @@ "type": "object" }, "RetrieveRequestStatusResponse": { -"description": "Response from the RetrieveRequestStatusRequest.", "id": "RetrieveRequestStatusResponse", "properties": { "requestStatusPerDestination": { -"description": "A list of request statuses per destination. The order of the statuses matches the order of the destinations in the original request.", "items": { "$ref": "RequestStatusPerDestination" }, @@ -3561,15 +3132,12 @@ "type": "object" }, "SearchPartnerLinksResponse": { -"description": "Response from the SearchPartnerLinksRequest.", "id": "SearchPartnerLinksResponse", "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" }, "partnerLinks": { -"description": "The partner links for the given account.", "items": { "$ref": "PartnerLink" }, @@ -3579,29 +3147,24 @@ "type": "object" }, "SizeInfo": { -"description": "Estimated number of members in this user list in different target networks.", "id": "SizeInfo", "properties": { "displayNetworkMembersCount": { -"description": "Output only. Estimated number of members in this user list, on the Google Display Network.", "format": "int64", "readOnly": true, "type": "string" }, "gmailMembersCount": { -"description": "Output only. Estimated number of members in this user list on Gmail.", "format": "int64", "readOnly": true, "type": "string" }, "searchNetworkMembersCount": { -"description": "Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns.", "format": "int64", "readOnly": true, "type": "string" }, "youtubeMembersCount": { -"description": "Output only. Estimated number of members in this user list on YouTube.", "format": "int64", "readOnly": true, "type": "string" @@ -3610,16 +3173,13 @@ "type": "object" }, "Status": { -"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { -"description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" }, "details": { -"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -3630,43 +3190,37 @@ "type": "array" }, "message": { -"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "type": "object" }, "TargetNetworkInfo": { -"description": "Eligibility information for different target networks.", "id": "TargetNetworkInfo", "properties": { "eligibleForDisplay": { -"description": "Output only. Indicates this user list is eligible for Google Display Network.", "readOnly": true, "type": "boolean" }, "eligibleForSearch": { -"description": "Optional. Indicates if this user list is eligible for Google Search Network.", "type": "boolean" } }, "type": "object" }, "TermsOfService": { -"description": "The terms of service that the user has accepted/rejected.", "id": "TermsOfService", "properties": { "customerMatchTermsOfServiceStatus": { -"description": "Optional. The Customer Match terms of service: https://support.google.com/adspolicy/answer/6299717. This must be accepted when ingesting UserData or MobileData. This field is not required for Partner Match User list.", "enum": [ "TERMS_OF_SERVICE_STATUS_UNSPECIFIED", "ACCEPTED", "REJECTED" ], "enumDescriptions": [ -"Not specified.", -"Status indicating the caller has chosen to accept the terms of service.", -"Status indicating the caller has chosen to reject the terms of service." +"", +"", +"" ], "type": "string" } @@ -3674,11 +3228,9 @@ "type": "object" }, "UserData": { -"description": "Data that identifies the user. At least one identifier is required.", "id": "UserData", "properties": { "userIdentifiers": { -"description": "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.", "items": { "$ref": "UserIdentifier" }, @@ -3688,22 +3240,18 @@ "type": "object" }, "UserIdData": { -"description": "User id data holding the user id.", "id": "UserIdData", "properties": { "userId": { -"description": "Required. A unique identifier for a user, as defined by the advertiser.", "type": "string" } }, "type": "object" }, "UserIdInfo": { -"description": "Additional information when `USER_ID` is one of the `upload_key_types`.", "id": "UserIdInfo", "properties": { "dataSourceType": { -"description": "Optional. Immutable. Source of the upload data.", "enum": [ "DATA_SOURCE_TYPE_UNSPECIFIED", "DATA_SOURCE_TYPE_FIRST_PARTY", @@ -3712,11 +3260,11 @@ "DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA" ], "enumDescriptions": [ -"Not specified.", -"The uploaded data is first-party data.", -"The uploaded data is from a third-party credit bureau.", -"The uploaded data is from a third-party voter file.", -"The uploaded data is third party partner data." +"", +"", +"", +"", +"" ], "type": "string" } @@ -3724,30 +3272,24 @@ "type": "object" }, "UserIdentifier": { -"description": "A single identifier for the user.", "id": "UserIdentifier", "properties": { "address": { -"$ref": "AddressInfo", -"description": "The known components of a user's address. Holds a grouping of identifiers that are matched all at once." +"$ref": "AddressInfo" }, "emailAddress": { -"description": "Hashed email address using SHA-256 hash function after normalization.", "type": "string" }, "phoneNumber": { -"description": "Hashed phone number using SHA-256 hash function after normalization (E164 standard).", "type": "string" } }, "type": "object" }, "UserList": { -"description": "A user list resource.", "id": "UserList", "properties": { "accessReason": { -"description": "Output only. The reason this account has been granted access to the list.", "enum": [ "ACCESS_REASON_UNSPECIFIED", "OWNED", @@ -3757,121 +3299,104 @@ "AFFILIATED" ], "enumDescriptions": [ -"Not specified.", -"The resource is owned by the user.", -"The resource is shared to the user.", -"The resource is licensed to the user.", -"The user subscribed to the resource.", -"The resource is accessible to the user." +"", +"", +"", +"", +"", +"" ], "readOnly": true, "type": "string" }, "accountAccessStatus": { -"description": "Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to `ENABLED`. Later the user list owner can decide to revoke the share and make it `DISABLED`.", "enum": [ "ACCESS_STATUS_UNSPECIFIED", "ENABLED", "DISABLED" ], "enumDescriptions": [ -"Not specified.", -"The access is enabled.", -"The access is disabled." +"", +"", +"" ], "type": "string" }, "closingReason": { -"description": "Output only. The reason why this user list membership status is closed.", "enum": [ "CLOSING_REASON_UNSPECIFIED", "UNUSED" ], "enumDescriptions": [ -"Not specified.", -"The user list was closed because it has not been used in targeting recently. See https://support.google.com/google-ads/answer/2472738 for details." +"", +"" ], "readOnly": true, "type": "string" }, "description": { -"description": "Optional. A description of the user list.", "type": "string" }, "displayName": { -"description": "Required. The display name of the user list.", "type": "string" }, "id": { -"description": "Output only. The unique ID of the user list.", "format": "int64", "readOnly": true, "type": "string" }, "ingestedUserListInfo": { -"$ref": "IngestedUserListInfo", -"description": "Optional. Represents a user list that is populated by user ingested data." +"$ref": "IngestedUserListInfo" }, "integrationCode": { -"description": "Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.", "type": "string" }, "membershipDuration": { -"description": "Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error.", "format": "google-duration", "type": "string" }, "membershipStatus": { -"description": "Optional. Membership status of this user list.", "enum": [ "MEMBERSHIP_STATUS_UNSPECIFIED", "OPEN", "CLOSED" ], "enumDescriptions": [ -"Not specified.", -"Open status - User list is accruing members and can be targeted to.", -"Closed status - No new members being added." +"", +"", +"" ], "type": "string" }, "name": { -"description": "Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}", "type": "string" }, "readOnly": { -"description": "Output only. An option that indicates if a user may edit a list.", "readOnly": true, "type": "boolean" }, "sizeInfo": { "$ref": "SizeInfo", -"description": "Output only. Estimated number of members in this user list in different target networks.", "readOnly": true }, "targetNetworkInfo": { -"$ref": "TargetNetworkInfo", -"description": "Optional. Eligibility information for different target networks." +"$ref": "TargetNetworkInfo" } }, "type": "object" }, "UserListDirectLicense": { -"description": "A user list direct license. This feature is only available to data partners.", "id": "UserListDirectLicense", "properties": { "clientAccountDisplayName": { -"description": "Output only. Name of client customer which the user list is being licensed to. This field is read-only.", "readOnly": true, "type": "string" }, "clientAccountId": { -"description": "Immutable. ID of client customer which the user list is being licensed to.", "format": "int64", "type": "string" }, "clientAccountType": { -"description": "Immutable. Account type of client customer which the user list is being licensed to.", "enum": [ "USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN", "USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS", @@ -3880,16 +3405,15 @@ "USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK" ], "enumDescriptions": [ -"Unknown.", -"Google Ads customer.", -"Display & Video 360 partner.", -"Display & Video 360 advertiser.", -"Google Ad Manager audience link." +"", +"", +"", +"", +"" ], "type": "string" }, "historicalPricings": { -"description": "Output only. Pricing history of this user list license. This field is read-only.", "items": { "$ref": "UserListLicensePricing" }, @@ -3898,38 +3422,32 @@ }, "metrics": { "$ref": "UserListLicenseMetrics", -"description": "Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call", "readOnly": true }, "name": { -"description": "Identifier. The resource name of the user list direct license.", "type": "string" }, "pricing": { -"$ref": "UserListLicensePricing", -"description": "Optional. UserListDirectLicense pricing." +"$ref": "UserListLicensePricing" }, "status": { -"description": "Optional. Status of UserListDirectLicense - ENABLED or DISABLED.", "enum": [ "USER_LIST_LICENSE_STATUS_UNSPECIFIED", "USER_LIST_LICENSE_STATUS_ENABLED", "USER_LIST_LICENSE_STATUS_DISABLED" ], "enumDescriptions": [ -"Unknown.", -"Active status - user list is still being licensed.", -"Inactive status - user list is no longer being licensed." +"", +"", +"" ], "type": "string" }, "userListDisplayName": { -"description": "Output only. Name of the user list being licensed. This field is read-only.", "readOnly": true, "type": "string" }, "userListId": { -"description": "Immutable. ID of the user list being licensed.", "format": "int64", "type": "string" } @@ -3937,11 +3455,9 @@ "type": "object" }, "UserListGlobalLicense": { -"description": "A user list global license. This feature is only available to data partners.", "id": "UserListGlobalLicense", "properties": { "historicalPricings": { -"description": "Output only. Pricing history of this user list license. This field is read-only.", "items": { "$ref": "UserListLicensePricing" }, @@ -3949,7 +3465,6 @@ "type": "array" }, "licenseType": { -"description": "Immutable. Product type of client customer which the user list is being licensed to.", "enum": [ "USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED", "USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER", @@ -3957,47 +3472,41 @@ "USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE" ], "enumDescriptions": [ -"UNSPECIFIED.", -"Reseller license.", -"DataMart Sell Side license.", -"DataMart Buy Side license." +"", +"", +"", +"" ], "type": "string" }, "metrics": { "$ref": "UserListLicenseMetrics", -"description": "Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call", "readOnly": true }, "name": { -"description": "Identifier. The resource name of the user list global license.", "type": "string" }, "pricing": { -"$ref": "UserListLicensePricing", -"description": "Optional. UserListGlobalLicense pricing." +"$ref": "UserListLicensePricing" }, "status": { -"description": "Optional. Status of UserListGlobalLicense - ENABLED or DISABLED.", "enum": [ "USER_LIST_LICENSE_STATUS_UNSPECIFIED", "USER_LIST_LICENSE_STATUS_ENABLED", "USER_LIST_LICENSE_STATUS_DISABLED" ], "enumDescriptions": [ -"Unknown.", -"Active status - user list is still being licensed.", -"Inactive status - user list is no longer being licensed." +"", +"", +"" ], "type": "string" }, "userListDisplayName": { -"description": "Output only. Name of the user list being licensed. This field is read-only.", "readOnly": true, "type": "string" }, "userListId": { -"description": "Immutable. ID of the user list being licensed.", "format": "int64", "type": "string" } @@ -4005,22 +3514,18 @@ "type": "object" }, "UserListGlobalLicenseCustomerInfo": { -"description": "Information about a customer of a user list global license. This will automatically be created by the system when a customer purchases a global license.", "id": "UserListGlobalLicenseCustomerInfo", "properties": { "clientAccountDisplayName": { -"description": "Output only. Name of client customer which the user list is being licensed to.", "readOnly": true, "type": "string" }, "clientAccountId": { -"description": "Output only. ID of client customer which the user list is being licensed to.", "format": "int64", "readOnly": true, "type": "string" }, "clientAccountType": { -"description": "Output only. Product type of client customer which the user list is being licensed to.", "enum": [ "USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN", "USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS", @@ -4029,17 +3534,16 @@ "USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK" ], "enumDescriptions": [ -"Unknown.", -"Google Ads customer.", -"Display & Video 360 partner.", -"Display & Video 360 advertiser.", -"Google Ad Manager audience link." +"", +"", +"", +"", +"" ], "readOnly": true, "type": "string" }, "historicalPricings": { -"description": "Output only. Pricing history of this user list license.", "items": { "$ref": "UserListLicensePricing" }, @@ -4047,7 +3551,6 @@ "type": "array" }, "licenseType": { -"description": "Output only. Product type of client customer which the user list is being licensed to.", "enum": [ "USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED", "USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER", @@ -4055,50 +3558,44 @@ "USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE" ], "enumDescriptions": [ -"UNSPECIFIED.", -"Reseller license.", -"DataMart Sell Side license.", -"DataMart Buy Side license." +"", +"", +"", +"" ], "readOnly": true, "type": "string" }, "metrics": { "$ref": "UserListLicenseMetrics", -"description": "Output only. Metrics related to this license This field is only populated if the start and end dates are set in the ListUserListGlobalLicenseCustomerInfos call.", "readOnly": true }, "name": { -"description": "Identifier. The resource name of the user list global license customer.", "type": "string" }, "pricing": { "$ref": "UserListLicensePricing", -"description": "Output only. UserListDirectLicense pricing.", "readOnly": true }, "status": { -"description": "Output only. Status of UserListDirectLicense - ENABLED or DISABLED.", "enum": [ "USER_LIST_LICENSE_STATUS_UNSPECIFIED", "USER_LIST_LICENSE_STATUS_ENABLED", "USER_LIST_LICENSE_STATUS_DISABLED" ], "enumDescriptions": [ -"Unknown.", -"Active status - user list is still being licensed.", -"Inactive status - user list is no longer being licensed." +"", +"", +"" ], "readOnly": true, "type": "string" }, "userListDisplayName": { -"description": "Output only. Name of the user list being licensed.", "readOnly": true, "type": "string" }, "userListId": { -"description": "Output only. ID of the user list being licensed.", "format": "int64", "readOnly": true, "type": "string" @@ -4107,35 +3604,29 @@ "type": "object" }, "UserListLicenseMetrics": { -"description": "Metrics related to a user list license.", "id": "UserListLicenseMetrics", "properties": { "clickCount": { -"description": "Output only. The number of clicks for the user list license.", "format": "int64", "readOnly": true, "type": "string" }, "endDate": { -"description": "Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.", "format": "int64", "readOnly": true, "type": "string" }, "impressionCount": { -"description": "Output only. The number of impressions for the user list license.", "format": "int64", "readOnly": true, "type": "string" }, "revenueUsdMicros": { -"description": "Output only. The revenue for the user list license in USD micros.", "format": "int64", "readOnly": true, "type": "string" }, "startDate": { -"description": "Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.", "format": "int64", "readOnly": true, "type": "string" @@ -4144,11 +3635,9 @@ "type": "object" }, "UserListLicensePricing": { -"description": "A user list license pricing.", "id": "UserListLicensePricing", "properties": { "buyerApprovalState": { -"description": "Output only. The buyer approval state of this pricing. This field is read-only.", "enum": [ "USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED", "PENDING", @@ -4156,21 +3645,19 @@ "REJECTED" ], "enumDescriptions": [ -"UNSPECIFIED.", -"User list client has not yet accepted the pricing terms set by the user list owner.", -"User list client has accepted the pricing terms set by the user list owner.", -"User list client has rejected the pricing terms set by the user list owner." +"", +"", +"", +"" ], "readOnly": true, "type": "string" }, "costMicros": { -"description": "Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`.", "format": "int64", "type": "string" }, "costType": { -"description": "Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.", "enum": [ "USER_LIST_PRICING_COST_TYPE_UNSPECIFIED", "CPC", @@ -4178,40 +3665,34 @@ "MEDIA_SHARE" ], "enumDescriptions": [ -"Unspecified.", -"Cost per click.", -"Cost per mille (thousand impressions).", -"Media share." +"", +"", +"", +"" ], "type": "string" }, "currencyCode": { -"description": "Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.", "type": "string" }, "endTime": { -"description": "Optional. End time of the pricing.", "format": "google-datetime", "type": "string" }, "maxCostMicros": { -"description": "Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap.", "format": "int64", "type": "string" }, "pricingActive": { -"description": "Output only. Whether this pricing is active.", "readOnly": true, "type": "boolean" }, "pricingId": { -"description": "Output only. The ID of this pricing.", "format": "int64", "readOnly": true, "type": "string" }, "startTime": { -"description": "Output only. Start time of the pricing.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -4220,18 +3701,15 @@ "type": "object" }, "UserProperties": { -"description": "Advertiser-assessed information about the user at the time that the event happened. See https://support.google.com/google-ads/answer/14007601 for more details.", "id": "UserProperties", "properties": { "additionalUserProperties": { -"description": "Optional. A bucket of any additional [user properties](https://developers.google.com/analytics/devguides/collection/protocol/ga4/user-properties) for the user associated with this event.", "items": { "$ref": "UserProperty" }, "type": "array" }, "customerType": { -"description": "Optional. Type of the customer associated with the event.", "enum": [ "CUSTOMER_TYPE_UNSPECIFIED", "NEW", @@ -4239,15 +3717,14 @@ "REENGAGED" ], "enumDescriptions": [ -"Unspecified CustomerType. Should never be used.", -"The customer is new to the advertiser.", -"The customer is returning to the advertiser.", -"The customer has re-engaged with the advertiser." +"", +"", +"", +"" ], "type": "string" }, "customerValueBucket": { -"description": "Optional. The advertiser-assessed value of the customer.", "enum": [ "CUSTOMER_VALUE_BUCKET_UNSPECIFIED", "LOW", @@ -4255,10 +3732,10 @@ "HIGH" ], "enumDescriptions": [ -"Unspecified CustomerValueBucket. Should never be used.", -"The customer is low value.", -"The customer is medium value.", -"The customer is high value." +"", +"", +"", +"" ], "type": "string" } @@ -4266,31 +3743,25 @@ "type": "object" }, "UserProperty": { -"description": "A bucket of any additional [user properties](https://developers.google.com/analytics/devguides/collection/protocol/ga4/user-properties) for the user associated with this event.", "id": "UserProperty", "properties": { "propertyName": { -"description": "Required. The name of the user property to use.", "type": "string" }, "value": { -"description": "Required. The string representation of the value of the user property to use.", "type": "string" } }, "type": "object" }, "ViewabilityInfo": { -"description": "Details of the viewability of the ad served.", "id": "ViewabilityInfo", "properties": { "mediaDuration": { -"description": "Optional. The duration of the ad media.", "format": "google-duration", "type": "string" }, "mediaQuartile": { -"description": "Optional. The amount of the media that was played as discrete quartiles.", "enum": [ "MEDIA_QUARTILE_UNSPECIFIED", "MEDIA_QUARTILE_START", @@ -4300,50 +3771,44 @@ "MEDIA_QUARTILE_COMPLETE" ], "enumDescriptions": [ -"Unspecified media quartile.", -"Start.", -"First quartile.", -"Midpoint.", -"Third quartile.", -"Complete." +"", +"", +"", +"", +"", +"" ], "type": "string" }, "mediaSkippable": { -"description": "Optional. Whether the ad media was skippable or not.", "type": "boolean" }, "mediaVolumePercent": { -"description": "Optional. The numerical percent (0-100) of the volume of the media playback.", "format": "int32", "type": "integer" }, "playbackDuration": { -"description": "Optional. The duration of playback of the ad media, regardless of whether it was viewable or not.", "format": "google-duration", "type": "string" }, "viewType": { -"description": "Required. The type of the event.", "enum": [ "VIEW_TYPE_UNSPECIFIED", "VIEW_TYPE_MRC_VIEWED", "VIEW_TYPE_MRC_RENDERED" ], "enumDescriptions": [ -"Unspecified view type.", -"MRC viewed.", -"MRC rendered." +"", +"", +"" ], "type": "string" }, "viewableDuration": { -"description": "Optional. The amount of time the ad was viewable for.", "format": "google-duration", "type": "string" }, "viewablePercent": { -"description": "Optional. The numerical percent (0-100) of the pixels that were viewable.", "format": "int32", "type": "integer" } @@ -4351,11 +3816,9 @@ "type": "object" }, "WarningCount": { -"description": "The warning count for a given warning reason.", "id": "WarningCount", "properties": { "reason": { -"description": "The warning reason.", "enum": [ "PROCESSING_WARNING_REASON_UNSPECIFIED", "PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED", @@ -4369,21 +3832,20 @@ "PROCESSING_WARNING_REASON_AWS_AUTH_FAILED" ], "enumDescriptions": [ -"The processing warning reason is unknown.", -"The system did not have the permissions needed to access the KEK.", -"The DEK failed to be decrypted.", -"The event has a decryption error.", -"The WIP could not be used because it was rejected by its attestation condition.", -"The WIP is formatted incorrectly or the WIP does not exist.", -"The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.", -"Failed to decrypt the UserIdentifier data using the DEK.", -"Internal error.", -"The system failed to authenticate with AWS." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "recordCount": { -"description": "The count of records that have a warning.", "format": "int64", "type": "string" } @@ -4391,11 +3853,9 @@ "type": "object" }, "WarningInfo": { -"description": "Warning counts for each type of warning.", "id": "WarningInfo", "properties": { "warningCounts": { -"description": "A list of warnings and counts per warning reason.", "items": { "$ref": "WarningCount" }, From 1bacbb5f468d6ace71bef5604eaf57cb870b623e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:29 +0000 Subject: [PATCH 14/30] feat(datamigration): update the api #### datamigration:v1 The following keys were added: - schemas.MySqlConnectionProfile.properties.privateConnectivity.$ref (Total Keys: 1) - schemas.MySqlConnectionProfile.properties.privateServiceConnectConnectivity.$ref (Total Keys: 1) - schemas.MySqlConnectionProfile.properties.staticServiceIpConnectivity.$ref (Total Keys: 1) - schemas.PerformanceConfig.properties.loadParallelLevel.type (Total Keys: 1) --- ...projects.locations.connectionProfiles.html | 40 +++++++++++++++++-- ...n_v1.projects.locations.migrationJobs.html | 15 ++++--- .../documents/datamigration.v1.json | 34 ++++++++++++++-- 3 files changed, 77 insertions(+), 12 deletions(-) diff --git a/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html b/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html index e354e72abb..c894b7542d 100644 --- a/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html +++ b/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html @@ -234,6 +234,12 @@

Method Details

"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. "passwordSet": True or False, # Output only. Indicates If this connection profile password is stored. "port": 42, # Required. The network port of the source MySQL database. + "privateConnectivity": { # Private Connectivity. # Private connectivity. + "privateConnection": "A String", # Required. The resource name (URI) of the private connection. + }, + "privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private Service Connect connectivity. + "serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name} + }, "ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database. "caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host. "clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory. @@ -243,6 +249,8 @@

Method Details

}, "type": "A String", # Optional. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. }, + "staticServiceIpConnectivity": { # Static IP address connectivity configured on service project. # Static Service IP connectivity. + }, "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. @@ -312,7 +320,7 @@

Method Details

"privateConnectivity": { # Private Connectivity. # Private connectivity. "privateConnection": "A String", # Required. The resource name (URI) of the private connection. }, - "privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private service connect connectivity. + "privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private Service Connect connectivity. "serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name} }, "ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database. @@ -574,6 +582,12 @@

Method Details

"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. "passwordSet": True or False, # Output only. Indicates If this connection profile password is stored. "port": 42, # Required. The network port of the source MySQL database. + "privateConnectivity": { # Private Connectivity. # Private connectivity. + "privateConnection": "A String", # Required. The resource name (URI) of the private connection. + }, + "privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private Service Connect connectivity. + "serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name} + }, "ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database. "caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host. "clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory. @@ -583,6 +597,8 @@

Method Details

}, "type": "A String", # Optional. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. }, + "staticServiceIpConnectivity": { # Static IP address connectivity configured on service project. # Static Service IP connectivity. + }, "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. @@ -652,7 +668,7 @@

Method Details

"privateConnectivity": { # Private Connectivity. # Private connectivity. "privateConnection": "A String", # Required. The resource name (URI) of the private connection. }, - "privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private service connect connectivity. + "privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private Service Connect connectivity. "serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name} }, "ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database. @@ -899,6 +915,12 @@

Method Details

"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. "passwordSet": True or False, # Output only. Indicates If this connection profile password is stored. "port": 42, # Required. The network port of the source MySQL database. + "privateConnectivity": { # Private Connectivity. # Private connectivity. + "privateConnection": "A String", # Required. The resource name (URI) of the private connection. + }, + "privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private Service Connect connectivity. + "serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name} + }, "ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database. "caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host. "clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory. @@ -908,6 +930,8 @@

Method Details

}, "type": "A String", # Optional. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. }, + "staticServiceIpConnectivity": { # Static IP address connectivity configured on service project. # Static Service IP connectivity. + }, "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. @@ -977,7 +1001,7 @@

Method Details

"privateConnectivity": { # Private Connectivity. # Private connectivity. "privateConnection": "A String", # Required. The resource name (URI) of the private connection. }, - "privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private service connect connectivity. + "privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private Service Connect connectivity. "serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name} }, "ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database. @@ -1185,6 +1209,12 @@

Method Details

"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. "passwordSet": True or False, # Output only. Indicates If this connection profile password is stored. "port": 42, # Required. The network port of the source MySQL database. + "privateConnectivity": { # Private Connectivity. # Private connectivity. + "privateConnection": "A String", # Required. The resource name (URI) of the private connection. + }, + "privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private Service Connect connectivity. + "serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name} + }, "ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database. "caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host. "clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory. @@ -1194,6 +1224,8 @@

Method Details

}, "type": "A String", # Optional. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. }, + "staticServiceIpConnectivity": { # Static IP address connectivity configured on service project. # Static Service IP connectivity. + }, "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. @@ -1263,7 +1295,7 @@

Method Details

"privateConnectivity": { # Private Connectivity. # Private connectivity. "privateConnection": "A String", # Required. The resource name (URI) of the private connection. }, - "privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private service connect connectivity. + "privateServiceConnectConnectivity": { # [Private Service Connect connectivity](https://cloud.google.com/vpc/docs/private-service-connect#service-attachments) # Private Service Connect connectivity. "serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name} }, "ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database. diff --git a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html index 1f6b600105..bb10f43e37 100644 --- a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html +++ b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html @@ -234,8 +234,9 @@

Method Details

}, }, "originalMigrationName": "A String", # Optional. A failback replication pointer to the resource name (URI) of the original migration job. - "performanceConfig": { # Performance configuration definition. # Optional. Data dump parallelism settings used by the migration. + "performanceConfig": { # Performance configuration definition. # Optional. Data dump and load parallelism settings used by the migration. "dumpParallelLevel": "A String", # Initial dump parallelism level. + "loadParallelLevel": "A String", # Optional. Initial load parallelism level. }, "phase": "A String", # Output only. The current migration job phase. "postgresHomogeneousConfig": { # Configuration for PostgreSQL to PostgreSQL migrations. # Optional. Configuration for PostgreSQL homogeneous migration. @@ -608,8 +609,9 @@

Method Details

}, }, "originalMigrationName": "A String", # Optional. A failback replication pointer to the resource name (URI) of the original migration job. - "performanceConfig": { # Performance configuration definition. # Optional. Data dump parallelism settings used by the migration. + "performanceConfig": { # Performance configuration definition. # Optional. Data dump and load parallelism settings used by the migration. "dumpParallelLevel": "A String", # Initial dump parallelism level. + "loadParallelLevel": "A String", # Optional. Initial load parallelism level. }, "phase": "A String", # Output only. The current migration job phase. "postgresHomogeneousConfig": { # Configuration for PostgreSQL to PostgreSQL migrations. # Optional. Configuration for PostgreSQL homogeneous migration. @@ -829,8 +831,9 @@

Method Details

}, }, "originalMigrationName": "A String", # Optional. A failback replication pointer to the resource name (URI) of the original migration job. - "performanceConfig": { # Performance configuration definition. # Optional. Data dump parallelism settings used by the migration. + "performanceConfig": { # Performance configuration definition. # Optional. Data dump and load parallelism settings used by the migration. "dumpParallelLevel": "A String", # Initial dump parallelism level. + "loadParallelLevel": "A String", # Optional. Initial load parallelism level. }, "phase": "A String", # Output only. The current migration job phase. "postgresHomogeneousConfig": { # Configuration for PostgreSQL to PostgreSQL migrations. # Optional. Configuration for PostgreSQL homogeneous migration. @@ -1011,8 +1014,9 @@

Method Details

}, }, "originalMigrationName": "A String", # Optional. A failback replication pointer to the resource name (URI) of the original migration job. - "performanceConfig": { # Performance configuration definition. # Optional. Data dump parallelism settings used by the migration. + "performanceConfig": { # Performance configuration definition. # Optional. Data dump and load parallelism settings used by the migration. "dumpParallelLevel": "A String", # Initial dump parallelism level. + "loadParallelLevel": "A String", # Optional. Initial load parallelism level. }, "phase": "A String", # Output only. The current migration job phase. "postgresHomogeneousConfig": { # Configuration for PostgreSQL to PostgreSQL migrations. # Optional. Configuration for PostgreSQL homogeneous migration. @@ -1558,8 +1562,9 @@

Method Details

}, }, "originalMigrationName": "A String", # Optional. A failback replication pointer to the resource name (URI) of the original migration job. - "performanceConfig": { # Performance configuration definition. # Optional. Data dump parallelism settings used by the migration. + "performanceConfig": { # Performance configuration definition. # Optional. Data dump and load parallelism settings used by the migration. "dumpParallelLevel": "A String", # Initial dump parallelism level. + "loadParallelLevel": "A String", # Optional. Initial load parallelism level. }, "phase": "A String", # Output only. The current migration job phase. "postgresHomogeneousConfig": { # Configuration for PostgreSQL to PostgreSQL migrations. # Optional. Configuration for PostgreSQL homogeneous migration. diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index 44b69dfb96..169c35ac5e 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -2592,7 +2592,7 @@ } } }, -"revision": "20260802", +"revision": "20260904", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -5346,7 +5346,7 @@ }, "performanceConfig": { "$ref": "PerformanceConfig", -"description": "Optional. Data dump parallelism settings used by the migration." +"description": "Optional. Data dump and load parallelism settings used by the migration." }, "phase": { "description": "Output only. The current migration job phase.", @@ -5790,10 +5790,22 @@ "format": "int32", "type": "integer" }, +"privateConnectivity": { +"$ref": "PrivateConnectivity", +"description": "Private connectivity." +}, +"privateServiceConnectConnectivity": { +"$ref": "PrivateServiceConnectConnectivity", +"description": "Private Service Connect connectivity." +}, "ssl": { "$ref": "SslConfig", "description": "SSL configuration for the destination to connect to the source database." }, +"staticServiceIpConnectivity": { +"$ref": "StaticServiceIpConnectivity", +"description": "Static Service IP connectivity." +}, "username": { "description": "Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.", "type": "string" @@ -6034,6 +6046,22 @@ "Maximum parallel level." ], "type": "string" +}, +"loadParallelLevel": { +"description": "Optional. Initial load parallelism level.", +"enum": [ +"LOAD_PARALLEL_LEVEL_UNSPECIFIED", +"LOAD_MIN", +"LOAD_OPTIMAL", +"LOAD_MAX" +], +"enumDescriptions": [ +"Unknown load parallel level.", +"Minimal parallel level.", +"Optimal parallel level.", +"Maximum parallel level." +], +"type": "string" } }, "type": "object" @@ -6159,7 +6187,7 @@ }, "privateServiceConnectConnectivity": { "$ref": "PrivateServiceConnectConnectivity", -"description": "Private service connect connectivity." +"description": "Private Service Connect connectivity." }, "ssl": { "$ref": "SslConfig", From b513cea108e43143b23f5e3aad6337bd0fb97009 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:29 +0000 Subject: [PATCH 15/30] feat(deploymentmanager): update the api #### deploymentmanager:alpha The following keys were added: - schemas.FirewallPolicyRuleOperationMetadata.properties.allocatedPriority.readOnly (Total Keys: 1) - schemas.GetHealthOperationMetadata (Total Keys: 17) - schemas.InstancesTroubleshootOperationMetadata (Total Keys: 4) - schemas.Operation.properties.details.$ref (Total Keys: 1) - schemas.Operation.properties.firewallPolicyRuleOperationMetadata.readOnly (Total Keys: 1) - schemas.Operation.properties.getHealthOperationMetadata (Total Keys: 2) - schemas.Operation.properties.instancesTroubleshootOperationMetadata (Total Keys: 2) - schemas.OperationDetails (Total Keys: 5) #### deploymentmanager:v2 The following keys were added: - schemas.FirewallPolicyRuleOperationMetadata.properties.allocatedPriority.readOnly (Total Keys: 1) - schemas.GetHealthOperationMetadata (Total Keys: 17) - schemas.InstancesTroubleshootOperationMetadata (Total Keys: 4) - schemas.Operation.properties.details.$ref (Total Keys: 1) - schemas.Operation.properties.firewallPolicyRuleOperationMetadata.readOnly (Total Keys: 1) - schemas.Operation.properties.getHealthOperationMetadata (Total Keys: 2) - schemas.Operation.properties.instancesTroubleshootOperationMetadata (Total Keys: 2) - schemas.OperationDetails (Total Keys: 5) --- ...eploymentmanager_alpha.compositeTypes.html | 378 ++++++++++---- .../deploymentmanager_alpha.deployments.html | 462 +++++++++++++----- .../deploymentmanager_alpha.operations.html | 84 +++- .../deploymentmanager_alpha.resources.html | 36 +- ...deploymentmanager_alpha.typeProviders.html | 378 ++++++++++---- docs/dyn/deploymentmanager_alpha.types.html | 84 +++- .../dyn/deploymentmanager_v2.deployments.html | 462 +++++++++++++----- docs/dyn/deploymentmanager_v2.operations.html | 84 +++- docs/dyn/deploymentmanager_v2.resources.html | 36 +- docs/dyn/deploymentmanager_v2.types.html | 42 +- .../documents/deploymentmanager.alpha.json | 198 +++++++- .../documents/deploymentmanager.v2.json | 198 +++++++- 12 files changed, 1800 insertions(+), 642 deletions(-) diff --git a/docs/dyn/deploymentmanager_alpha.compositeTypes.html b/docs/dyn/deploymentmanager_alpha.compositeTypes.html index 350374f56d..1dc60933f7 100644 --- a/docs/dyn/deploymentmanager_alpha.compositeTypes.html +++ b/docs/dyn/deploymentmanager_alpha.compositeTypes.html @@ -124,30 +124,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -155,11 +161,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -176,15 +182,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -205,6 +220,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -247,7 +265,7 @@

Method Details

"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" } + "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. @@ -291,30 +309,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -322,11 +346,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -343,15 +367,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -372,6 +405,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -414,7 +450,7 @@

Method Details

"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" } + "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. @@ -466,30 +502,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -497,11 +539,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -518,15 +560,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -547,6 +598,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -589,7 +643,7 @@

Method Details

"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" } + "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. @@ -629,30 +683,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -660,11 +720,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -681,15 +741,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -710,6 +779,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -752,7 +824,7 @@

Method Details

"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" } + "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. @@ -800,30 +872,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -831,11 +909,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -852,15 +930,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -881,6 +968,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -923,7 +1013,7 @@

Method Details

"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" } + "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. @@ -993,30 +1083,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1024,11 +1120,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1045,15 +1141,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1074,6 +1179,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1116,7 +1224,7 @@

Method Details

"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" } + "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. @@ -1156,30 +1264,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1187,11 +1301,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1208,15 +1322,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1237,6 +1360,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1279,7 +1405,7 @@

Method Details

"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" } + "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. @@ -1317,30 +1443,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1348,11 +1480,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1369,15 +1501,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1398,6 +1539,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1440,7 +1584,7 @@

Method Details

"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" } + "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. @@ -1480,30 +1624,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1511,11 +1661,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for 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 +1682,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1561,6 +1720,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1603,7 +1765,7 @@

Method Details

"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" } + "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. diff --git a/docs/dyn/deploymentmanager_alpha.deployments.html b/docs/dyn/deploymentmanager_alpha.deployments.html index ed736496d6..21acb2fce1 100644 --- a/docs/dyn/deploymentmanager_alpha.deployments.html +++ b/docs/dyn/deploymentmanager_alpha.deployments.html @@ -140,30 +140,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -171,11 +177,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -192,15 +198,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -221,6 +236,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -263,7 +281,7 @@

Method Details

"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" } + "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. @@ -305,30 +323,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -336,11 +360,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -357,15 +381,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -386,6 +419,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -428,7 +464,7 @@

Method Details

"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" } + "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. @@ -484,30 +520,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -515,11 +557,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for 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,15 +578,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -565,6 +616,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -607,7 +661,7 @@

Method Details

"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" } + "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. @@ -746,30 +800,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -777,11 +837,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for 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,15 +858,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -827,6 +896,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -869,7 +941,7 @@

Method Details

"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" } + "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. @@ -940,30 +1012,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -971,11 +1049,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -992,15 +1070,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1021,6 +1108,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1063,7 +1153,7 @@

Method Details

"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" } + "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. @@ -1123,30 +1213,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1154,11 +1250,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1175,15 +1271,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1204,6 +1309,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1246,7 +1354,7 @@

Method Details

"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" } + "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. @@ -1353,30 +1461,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1384,11 +1498,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for 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,15 +1519,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1434,6 +1557,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1476,7 +1602,7 @@

Method Details

"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" } + "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. @@ -1551,30 +1677,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1582,11 +1714,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1603,15 +1735,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1632,6 +1773,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1674,7 +1818,7 @@

Method Details

"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" } + "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. @@ -1814,30 +1958,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1845,11 +1995,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1866,15 +2016,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1895,6 +2054,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1937,7 +2099,7 @@

Method Details

"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" } + "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. @@ -2019,30 +2181,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -2050,11 +2218,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2071,15 +2239,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -2100,6 +2277,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -2142,7 +2322,7 @@

Method Details

"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" } + "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. @@ -2217,30 +2397,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -2248,11 +2434,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for 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 +2455,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -2298,6 +2493,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -2340,7 +2538,7 @@

Method Details

"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" } + "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. diff --git a/docs/dyn/deploymentmanager_alpha.operations.html b/docs/dyn/deploymentmanager_alpha.operations.html index 830fd98280..7aee55ffed 100644 --- a/docs/dyn/deploymentmanager_alpha.operations.html +++ b/docs/dyn/deploymentmanager_alpha.operations.html @@ -112,30 +112,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -143,11 +149,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -164,15 +170,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -193,6 +208,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -235,7 +253,7 @@

Method Details

"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" } + "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. @@ -273,30 +291,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -304,11 +328,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -325,15 +349,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -354,6 +387,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -396,7 +432,7 @@

Method Details

"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" } + "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. diff --git a/docs/dyn/deploymentmanager_alpha.resources.html b/docs/dyn/deploymentmanager_alpha.resources.html index 0229b94770..83d6bb2942 100644 --- a/docs/dyn/deploymentmanager_alpha.resources.html +++ b/docs/dyn/deploymentmanager_alpha.resources.html @@ -149,27 +149,27 @@

Method Details

}, "error": { # Output only. If errors are generated during update of the resource, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -177,11 +177,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -209,7 +209,7 @@

Method Details

"warnings": [ # Output only. If warning messages are generated during processing of this resource, 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" } + "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. @@ -224,7 +224,7 @@

Method Details

"warnings": [ # Output only. If warning messages are generated during processing of this resource, 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" } + "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. @@ -298,27 +298,27 @@

Method Details

}, "error": { # Output only. If errors are generated during update of the resource, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -326,11 +326,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -358,7 +358,7 @@

Method Details

"warnings": [ # Output only. If warning messages are generated during processing of this resource, 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" } + "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. @@ -373,7 +373,7 @@

Method Details

"warnings": [ # Output only. If warning messages are generated during processing of this resource, 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" } + "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. diff --git a/docs/dyn/deploymentmanager_alpha.typeProviders.html b/docs/dyn/deploymentmanager_alpha.typeProviders.html index bd9f4fe72f..6d207ebea9 100644 --- a/docs/dyn/deploymentmanager_alpha.typeProviders.html +++ b/docs/dyn/deploymentmanager_alpha.typeProviders.html @@ -133,30 +133,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -164,11 +170,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -185,15 +191,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -214,6 +229,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -256,7 +274,7 @@

Method Details

"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" } + "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. @@ -358,30 +376,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -389,11 +413,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -410,15 +434,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -439,6 +472,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -481,7 +517,7 @@

Method Details

"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" } + "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. @@ -641,30 +677,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -672,11 +714,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for 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,15 +735,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -722,6 +773,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -764,7 +818,7 @@

Method Details

"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" } + "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. @@ -823,30 +877,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -854,11 +914,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for 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 +935,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -904,6 +973,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -946,7 +1018,7 @@

Method Details

"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" } + "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. @@ -1053,30 +1125,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1084,11 +1162,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for 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 +1183,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1134,6 +1221,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1176,7 +1266,7 @@

Method Details

"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" } + "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. @@ -1374,30 +1464,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1405,11 +1501,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for 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 +1522,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1455,6 +1560,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1497,7 +1605,7 @@

Method Details

"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" } + "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. @@ -1556,30 +1664,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1587,11 +1701,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for 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,15 +1722,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1637,6 +1760,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1679,7 +1805,7 @@

Method Details

"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" } + "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. @@ -1775,30 +1901,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1806,11 +1938,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1827,15 +1959,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1856,6 +1997,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1898,7 +2042,7 @@

Method Details

"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" } + "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. @@ -1957,30 +2101,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1988,11 +2138,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2009,15 +2159,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -2038,6 +2197,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -2080,7 +2242,7 @@

Method Details

"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" } + "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. diff --git a/docs/dyn/deploymentmanager_alpha.types.html b/docs/dyn/deploymentmanager_alpha.types.html index 494f197f94..477ba91a55 100644 --- a/docs/dyn/deploymentmanager_alpha.types.html +++ b/docs/dyn/deploymentmanager_alpha.types.html @@ -212,30 +212,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -243,11 +249,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for 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,15 +270,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -293,6 +308,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -335,7 +353,7 @@

Method Details

"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" } + "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. @@ -475,30 +493,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -506,11 +530,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -527,15 +551,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -556,6 +589,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -598,7 +634,7 @@

Method Details

"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" } + "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. diff --git a/docs/dyn/deploymentmanager_v2.deployments.html b/docs/dyn/deploymentmanager_v2.deployments.html index a3e8d3dd51..9328348bc6 100644 --- a/docs/dyn/deploymentmanager_v2.deployments.html +++ b/docs/dyn/deploymentmanager_v2.deployments.html @@ -140,30 +140,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -171,11 +177,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -192,15 +198,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -221,6 +236,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -263,7 +281,7 @@

Method Details

"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" } + "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. @@ -305,30 +323,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -336,11 +360,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -357,15 +381,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -386,6 +419,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -428,7 +464,7 @@

Method Details

"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" } + "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. @@ -474,30 +510,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -505,11 +547,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for 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 +568,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -555,6 +606,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -597,7 +651,7 @@

Method Details

"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" } + "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. @@ -710,30 +764,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -741,11 +801,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for 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,15 +822,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -791,6 +860,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -833,7 +905,7 @@

Method Details

"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" } + "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. @@ -887,30 +959,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -918,11 +996,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for 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 +1017,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -968,6 +1055,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1010,7 +1100,7 @@

Method Details

"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" } + "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. @@ -1060,30 +1150,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1091,11 +1187,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1112,15 +1208,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1141,6 +1246,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1183,7 +1291,7 @@

Method Details

"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" } + "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. @@ -1264,30 +1372,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1295,11 +1409,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1316,15 +1430,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1345,6 +1468,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1387,7 +1513,7 @@

Method Details

"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" } + "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. @@ -1445,30 +1571,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1476,11 +1608,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1497,15 +1629,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1526,6 +1667,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1568,7 +1712,7 @@

Method Details

"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" } + "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. @@ -1708,30 +1852,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1739,11 +1889,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1760,15 +1910,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1789,6 +1948,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -1831,7 +1993,7 @@

Method Details

"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" } + "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. @@ -1903,30 +2065,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -1934,11 +2102,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -1955,15 +2123,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -1984,6 +2161,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -2026,7 +2206,7 @@

Method Details

"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" } + "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. @@ -2084,30 +2264,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -2115,11 +2301,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -2136,15 +2322,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -2165,6 +2360,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -2207,7 +2405,7 @@

Method Details

"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" } + "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. diff --git a/docs/dyn/deploymentmanager_v2.operations.html b/docs/dyn/deploymentmanager_v2.operations.html index ee6d91bb61..cac589b5e8 100644 --- a/docs/dyn/deploymentmanager_v2.operations.html +++ b/docs/dyn/deploymentmanager_v2.operations.html @@ -112,30 +112,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -143,11 +149,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -164,15 +170,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -193,6 +208,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -235,7 +253,7 @@

Method Details

"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" } + "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. @@ -273,30 +291,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -304,11 +328,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -325,15 +349,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -354,6 +387,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -396,7 +432,7 @@

Method Details

"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" } + "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. diff --git a/docs/dyn/deploymentmanager_v2.resources.html b/docs/dyn/deploymentmanager_v2.resources.html index 4fd97de738..0c88be99e4 100644 --- a/docs/dyn/deploymentmanager_v2.resources.html +++ b/docs/dyn/deploymentmanager_v2.resources.html @@ -126,27 +126,27 @@

Method Details

}, "error": { # Output only. If errors are generated during update of the resource, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -154,11 +154,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -183,7 +183,7 @@

Method Details

"warnings": [ # Output only. If warning messages are generated during processing of this resource, 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" } + "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. @@ -198,7 +198,7 @@

Method Details

"warnings": [ # Output only. If warning messages are generated during processing of this resource, 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" } + "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. @@ -249,27 +249,27 @@

Method Details

}, "error": { # Output only. If errors are generated during update of the resource, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -277,11 +277,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for 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,7 +306,7 @@

Method Details

"warnings": [ # Output only. If warning messages are generated during processing of this resource, 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" } + "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. @@ -321,7 +321,7 @@

Method Details

"warnings": [ # Output only. If warning messages are generated during processing of this resource, 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" } + "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. diff --git a/docs/dyn/deploymentmanager_v2.types.html b/docs/dyn/deploymentmanager_v2.types.html index df8bb33dae..e153099f8f 100644 --- a/docs/dyn/deploymentmanager_v2.types.html +++ b/docs/dyn/deploymentmanager_v2.types.html @@ -118,30 +118,36 @@

Method Details

"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. + "details": { # [Output Only] Extended details about the operation's execution. + "data": { # Machine readable data from the message. + "a_key": "", + }, + "message": "A String", # Human or AI readable details on execution of the operation. + }, "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { + { # Represents a single error encountered during the processing of an operation. "arguments": [ # Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field. "A String", ], "code": "A String", # [Output Only] The error type identifier for this error. - "debugInfo": { # Describes additional debugging info. + "debugInfo": { # Describes additional debugging info. # Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error. "detail": "A String", # Additional debugging information provided by the server. "stackEntries": [ # The stack trace entries indicating where the error occurred. "A String", ], }, "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + { # Container for structured error details providing additional context specific to the encountered error code. + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } # Error information containing structured domain, reason, and metadata. "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. "a_key": "A String", }, "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. # Links and information to help the user resolve the error. "links": [ # URL(s) pointing to additional information on handling the current error. { # Describes a URL link. "description": "A String", # Describes what the link offers. @@ -149,11 +155,11 @@

Method Details

}, ], }, - "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. # A localized human-readable error message intended for end users. "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" "message": "A String", # The localized error message in the above locale. }, - "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. "dimensions": { # The map holding related quota dimensions. "a_key": "A String", }, @@ -170,15 +176,24 @@

Method Details

}, ], }, - "firewallPolicyRuleOperationMetadata": { - "allocatedPriority": 42, # The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user. + "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority. + }, + "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. + "healthInfo": { # Health information. # Output only. The health information. + "availabilitySloStatus": "A String", # Output only. The availability SLO status. + "healthStatus": "A String", # Output only. The health status. + "repairCategory": "A String", # Output only. The repair category. + "unhealthyReason": "A String", # Output only. The reason for unhealthy status. + "updateTime": "A String", # Output only. The time when health info was updated. + }, }, "getVersionOperationMetadata": { "inlineSbomInfo": { - "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component name and the value is the version. + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", }, - "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version. + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate identifiers. "a_key": "A String", }, }, @@ -199,6 +214,9 @@

Method Details

}, }, }, + "instancesTroubleshootOperationMetadata": { # [Output Only] Operation metadata for instances.troubleshoot. # Output only. [Output Only] Operation metadata for instances.troubleshoot. + "troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. + }, "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. @@ -241,7 +259,7 @@

Method Details

"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" } + "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. diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json index 27796183d0..465a8de464 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json @@ -1676,7 +1676,7 @@ } } }, -"revision": "20260312", +"revision": "20260827", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -1827,13 +1827,15 @@ "STATUS_UNSPECIFIED", "CREATING", "ROLLING_BACK", -"DONE" +"DONE", +"PENDING" ], "enumDescriptions": [ "", "Rolling forward - creating VMs.", "Rolling back - cleaning up after an error.", -"Done" +"Done", +"Pending - waiting until the capacity is available." ], "type": "string" }, @@ -2252,16 +2254,111 @@ "type": "object" }, "FirewallPolicyRuleOperationMetadata": { +"description": "Metadata for FirewallPolicyRule operations.", "id": "FirewallPolicyRuleOperationMetadata", "properties": { "allocatedPriority": { -"description": "The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority.", +"description": "Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority.", "format": "int32", +"readOnly": true, "type": "integer" } }, "type": "object" }, +"GetHealthOperationMetadata": { +"description": "Metadata for GetHealth operations.", +"id": "GetHealthOperationMetadata", +"properties": { +"healthInfo": { +"$ref": "GetHealthOperationMetadataHealthInfo", +"description": "Output only. The health information.", +"readOnly": true +} +}, +"type": "object" +}, +"GetHealthOperationMetadataHealthInfo": { +"description": "Health information.", +"id": "GetHealthOperationMetadataHealthInfo", +"properties": { +"availabilitySloStatus": { +"description": "Output only. The availability SLO status.", +"enum": [ +"AVAILABILITY_SLO_STATUS_UNSPECIFIED", +"AVAILABILITY_SLO_STATUS_IN_SLO", +"AVAILABILITY_SLO_STATUS_OUT_OF_SLO", +"AVAILABILITY_SLO_STATUS_SLO_UNKNOWN" +], +"enumDescriptions": [ +"Unspecified availability SLO status.", +"The slot availability is in SLO.", +"The slot availability is out of SLO.", +"The slot availability is unknown." +], +"readOnly": true, +"type": "string" +}, +"healthStatus": { +"description": "Output only. The health status.", +"enum": [ +"HEALTH_STATUS_UNSPECIFIED", +"HEALTH_STATUS_HEALTHY", +"HEALTH_STATUS_UNHEALTHY" +], +"enumDescriptions": [ +"Unspecified health status.", +"The reservation slot is healthy.", +"The reservation slot is unhealthy." +], +"readOnly": true, +"type": "string" +}, +"repairCategory": { +"description": "Output only. The repair category.", +"enum": [ +"REPAIR_CATEGORY_UNSPECIFIED", +"REPAIR_CATEGORY_PLANNED_MAINTENANCE", +"REPAIR_CATEGORY_EMERGENT_MAINTENANCE", +"REPAIR_CATEGORY_USER_REPORTED_FAULT", +"REPAIR_CATEGORY_CRITICAL_FAILURE" +], +"enumDescriptions": [ +"Unspecified repair category.", +"The repair is because of a planned maintenance", +"The repair is because of an emergent maintenance", +"The repair is because of a user reported fault", +"The repair is because of critical failures, that are scoped outside emergent maintenance" +], +"readOnly": true, +"type": "string" +}, +"unhealthyReason": { +"description": "Output only. The reason for unhealthy status.", +"enum": [ +"UNHEALTHY_REASON_UNSPECIFIED", +"UNHEALTHY_REASON_REPAIRING", +"UNHEALTHY_REASON_PENDING_USER_APPROVAL", +"UNHEALTHY_REASON_UNSCHEDULABLE" +], +"enumDescriptions": [ +"Unspecified unhealthy reason.", +"The slot is unhealthy because repair is in progress", +"The slot is unhealthy because there is a pending repair, waiting for customer approval", +"The slot is unhealthy because a vm cannot be scheduled on it, and no repairs are running on the slot" +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when health info was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GetVersionOperationMetadata": { "id": "GetVersionOperationMetadata", "properties": { @@ -2278,14 +2375,14 @@ "additionalProperties": { "type": "string" }, -"description": "SBOM versions currently applied to the resource. The key is the component name and the value is the version.", +"description": "A mapping of components to their currently-applied versions or other appropriate identifiers.", "type": "object" }, "targetComponentVersions": { "additionalProperties": { "type": "string" }, -"description": "SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version.", +"description": "A mapping of components to their target versions or other appropriate identifiers.", "type": "object" } }, @@ -2415,6 +2512,18 @@ }, "type": "object" }, +"InstancesTroubleshootOperationMetadata": { +"description": "[Output Only] Operation metadata for instances.troubleshoot.", +"id": "InstancesTroubleshootOperationMetadata", +"properties": { +"troubleshootOutput": { +"description": "Output only. [Output Only] Serialized output of the troubleshooting diagnostic run.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "LocalizedMessage": { "description": "Provides a localized error message that is safe to return to the user which can be attached to an RPC error.", "id": "LocalizedMessage", @@ -2542,6 +2651,10 @@ "description": "[Output Only] A textual description of the operation, which is set when the operation is created.", "type": "string" }, +"details": { +"$ref": "OperationDetails", +"description": "[Output Only] Extended details about the operation's execution." +}, "endTime": { "description": "[Output Only] The time that this operation was completed. This value is in RFC3339 text format.", "type": "string" @@ -2552,6 +2665,7 @@ "errors": { "description": "[Output Only] The array of errors encountered while processing this operation.", "items": { +"description": "Represents a single error encountered during the processing of an operation.", "properties": { "arguments": { "description": "Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility \"none\") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field.", @@ -2567,23 +2681,29 @@ }, "debugInfo": { "$ref": "DebugInfo", +"description": "Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error.", "readOnly": true }, "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context specific 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" @@ -2607,7 +2727,14 @@ "type": "object" }, "firewallPolicyRuleOperationMetadata": { -"$ref": "FirewallPolicyRuleOperationMetadata" +"$ref": "FirewallPolicyRuleOperationMetadata", +"description": "Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user.", +"readOnly": true +}, +"getHealthOperationMetadata": { +"$ref": "GetHealthOperationMetadata", +"description": "Output only. Metadata for GetHealth operations.", +"readOnly": true }, "getVersionOperationMetadata": { "$ref": "GetVersionOperationMetadata" @@ -2633,6 +2760,11 @@ "instancesBulkInsertOperationMetadata": { "$ref": "InstancesBulkInsertOperationMetadata" }, +"instancesTroubleshootOperationMetadata": { +"$ref": "InstancesTroubleshootOperationMetadata", +"description": "Output only. [Output Only] Operation metadata for instances.troubleshoot.", +"readOnly": true +}, "kind": { "default": "compute#operation", "description": "Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources.", @@ -2691,9 +2823,9 @@ "DONE" ], "enumDescriptions": [ -"", -"", -"" +"The operation is waiting to be processed.", +"The operation is actively being processed.", +"The operation has completed processing successfully or with an error." ], "type": "string" }, @@ -2852,7 +2984,7 @@ false "type": "string" }, "data": { -"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }] ", "items": { "properties": { "key": { @@ -2884,6 +3016,23 @@ false }, "type": "object" }, +"OperationDetails": { +"id": "OperationDetails", +"properties": { +"data": { +"additionalProperties": { +"type": "any" +}, +"description": "Machine readable data from the message.", +"type": "object" +}, +"message": { +"description": "Human or AI readable details on execution of the operation.", +"type": "string" +} +}, +"type": "object" +}, "OperationsListResponse": { "description": "A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.", "id": "OperationsListResponse", @@ -3243,7 +3392,7 @@ false "type": "string" }, "data": { -"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }] ", "items": { "properties": { "key": { @@ -3299,6 +3448,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this operation.", "items": { +"description": "Represents a single error encountered during the processing of an operation.", "properties": { "arguments": { "description": "Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility \"none\") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field.", @@ -3314,23 +3464,29 @@ false }, "debugInfo": { "$ref": "DebugInfo", +"description": "Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error.", "readOnly": true }, "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context specific 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" @@ -3560,7 +3716,7 @@ false "type": "string" }, "data": { -"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }] ", "items": { "properties": { "key": { diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json index b950027bcd..b44db6d018 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json @@ -1028,7 +1028,7 @@ } } }, -"revision": "20260312", +"revision": "20260827", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -1125,13 +1125,15 @@ "STATUS_UNSPECIFIED", "CREATING", "ROLLING_BACK", -"DONE" +"DONE", +"PENDING" ], "enumDescriptions": [ "", "Rolling forward - creating VMs.", "Rolling back - cleaning up after an error.", -"Done" +"Done", +"Pending - waiting until the capacity is available." ], "type": "string" }, @@ -1366,16 +1368,111 @@ "type": "object" }, "FirewallPolicyRuleOperationMetadata": { +"description": "Metadata for FirewallPolicyRule operations.", "id": "FirewallPolicyRuleOperationMetadata", "properties": { "allocatedPriority": { -"description": "The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority.", +"description": "Output only. [Output Only] The priority allocated for the firewall policy rule if query parameters specified minPriority/maxPriority.", "format": "int32", +"readOnly": true, "type": "integer" } }, "type": "object" }, +"GetHealthOperationMetadata": { +"description": "Metadata for GetHealth operations.", +"id": "GetHealthOperationMetadata", +"properties": { +"healthInfo": { +"$ref": "GetHealthOperationMetadataHealthInfo", +"description": "Output only. The health information.", +"readOnly": true +} +}, +"type": "object" +}, +"GetHealthOperationMetadataHealthInfo": { +"description": "Health information.", +"id": "GetHealthOperationMetadataHealthInfo", +"properties": { +"availabilitySloStatus": { +"description": "Output only. The availability SLO status.", +"enum": [ +"AVAILABILITY_SLO_STATUS_UNSPECIFIED", +"AVAILABILITY_SLO_STATUS_IN_SLO", +"AVAILABILITY_SLO_STATUS_OUT_OF_SLO", +"AVAILABILITY_SLO_STATUS_SLO_UNKNOWN" +], +"enumDescriptions": [ +"Unspecified availability SLO status.", +"The slot availability is in SLO.", +"The slot availability is out of SLO.", +"The slot availability is unknown." +], +"readOnly": true, +"type": "string" +}, +"healthStatus": { +"description": "Output only. The health status.", +"enum": [ +"HEALTH_STATUS_UNSPECIFIED", +"HEALTH_STATUS_HEALTHY", +"HEALTH_STATUS_UNHEALTHY" +], +"enumDescriptions": [ +"Unspecified health status.", +"The reservation slot is healthy.", +"The reservation slot is unhealthy." +], +"readOnly": true, +"type": "string" +}, +"repairCategory": { +"description": "Output only. The repair category.", +"enum": [ +"REPAIR_CATEGORY_UNSPECIFIED", +"REPAIR_CATEGORY_PLANNED_MAINTENANCE", +"REPAIR_CATEGORY_EMERGENT_MAINTENANCE", +"REPAIR_CATEGORY_USER_REPORTED_FAULT", +"REPAIR_CATEGORY_CRITICAL_FAILURE" +], +"enumDescriptions": [ +"Unspecified repair category.", +"The repair is because of a planned maintenance", +"The repair is because of an emergent maintenance", +"The repair is because of a user reported fault", +"The repair is because of critical failures, that are scoped outside emergent maintenance" +], +"readOnly": true, +"type": "string" +}, +"unhealthyReason": { +"description": "Output only. The reason for unhealthy status.", +"enum": [ +"UNHEALTHY_REASON_UNSPECIFIED", +"UNHEALTHY_REASON_REPAIRING", +"UNHEALTHY_REASON_PENDING_USER_APPROVAL", +"UNHEALTHY_REASON_UNSCHEDULABLE" +], +"enumDescriptions": [ +"Unspecified unhealthy reason.", +"The slot is unhealthy because repair is in progress", +"The slot is unhealthy because there is a pending repair, waiting for customer approval", +"The slot is unhealthy because a vm cannot be scheduled on it, and no repairs are running on the slot" +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when health info was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GetVersionOperationMetadata": { "id": "GetVersionOperationMetadata", "properties": { @@ -1392,14 +1489,14 @@ "additionalProperties": { "type": "string" }, -"description": "SBOM versions currently applied to the resource. The key is the component name and the value is the version.", +"description": "A mapping of components to their currently-applied versions or other appropriate identifiers.", "type": "object" }, "targetComponentVersions": { "additionalProperties": { "type": "string" }, -"description": "SBOM versions scheduled for the next maintenance. The key is the component name and the value is the version.", +"description": "A mapping of components to their target versions or other appropriate identifiers.", "type": "object" } }, @@ -1492,6 +1589,18 @@ }, "type": "object" }, +"InstancesTroubleshootOperationMetadata": { +"description": "[Output Only] Operation metadata for instances.troubleshoot.", +"id": "InstancesTroubleshootOperationMetadata", +"properties": { +"troubleshootOutput": { +"description": "Output only. [Output Only] Serialized output of the troubleshooting diagnostic run.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "LocalizedMessage": { "description": "Provides a localized error message that is safe to return to the user which can be attached to an RPC error.", "id": "LocalizedMessage", @@ -1592,6 +1701,10 @@ "description": "[Output Only] A textual description of the operation, which is set when the operation is created.", "type": "string" }, +"details": { +"$ref": "OperationDetails", +"description": "[Output Only] Extended details about the operation's execution." +}, "endTime": { "description": "[Output Only] The time that this operation was completed. This value is in RFC3339 text format.", "type": "string" @@ -1602,6 +1715,7 @@ "errors": { "description": "[Output Only] The array of errors encountered while processing this operation.", "items": { +"description": "Represents a single error encountered during the processing of an operation.", "properties": { "arguments": { "description": "Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility \"none\") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field.", @@ -1617,23 +1731,29 @@ }, "debugInfo": { "$ref": "DebugInfo", +"description": "Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error.", "readOnly": true }, "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context specific 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" @@ -1657,7 +1777,14 @@ "type": "object" }, "firewallPolicyRuleOperationMetadata": { -"$ref": "FirewallPolicyRuleOperationMetadata" +"$ref": "FirewallPolicyRuleOperationMetadata", +"description": "Output only. [Output Only] Metadata containing the allocated priority from the networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule methods if not explicitly provided by the user.", +"readOnly": true +}, +"getHealthOperationMetadata": { +"$ref": "GetHealthOperationMetadata", +"description": "Output only. Metadata for GetHealth operations.", +"readOnly": true }, "getVersionOperationMetadata": { "$ref": "GetVersionOperationMetadata" @@ -1683,6 +1810,11 @@ "instancesBulkInsertOperationMetadata": { "$ref": "InstancesBulkInsertOperationMetadata" }, +"instancesTroubleshootOperationMetadata": { +"$ref": "InstancesTroubleshootOperationMetadata", +"description": "Output only. [Output Only] Operation metadata for instances.troubleshoot.", +"readOnly": true +}, "kind": { "default": "compute#operation", "description": "Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources.", @@ -1741,9 +1873,9 @@ "DONE" ], "enumDescriptions": [ -"", -"", -"" +"The operation is waiting to be processed.", +"The operation is actively being processed.", +"The operation has completed processing successfully or with an error." ], "type": "string" }, @@ -1902,7 +2034,7 @@ false "type": "string" }, "data": { -"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }] ", "items": { "properties": { "key": { @@ -1934,6 +2066,23 @@ false }, "type": "object" }, +"OperationDetails": { +"id": "OperationDetails", +"properties": { +"data": { +"additionalProperties": { +"type": "any" +}, +"description": "Machine readable data from the message.", +"type": "object" +}, +"message": { +"description": "Human or AI readable details on execution of the operation.", +"type": "string" +} +}, +"type": "object" +}, "OperationsListResponse": { "description": "A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.", "id": "OperationsListResponse", @@ -2212,7 +2361,7 @@ false "type": "string" }, "data": { -"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }] ", "items": { "properties": { "key": { @@ -2264,6 +2413,7 @@ false "errors": { "description": "[Output Only] The array of errors encountered while processing this operation.", "items": { +"description": "Represents a single error encountered during the processing of an operation.", "properties": { "arguments": { "description": "Output only. [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility \"none\") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field.", @@ -2279,23 +2429,29 @@ false }, "debugInfo": { "$ref": "DebugInfo", +"description": "Output only. [Output Only] Advanced debugging information with stack traces and other diagnostic details for the error.", "readOnly": true }, "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", "items": { +"description": "Container for structured error details providing additional context specific 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" @@ -2506,7 +2662,7 @@ false "type": "string" }, "data": { -"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }] ", "items": { "properties": { "key": { From 0bbe898254d312e22b2df83b97f89580d6fe671b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:29 +0000 Subject: [PATCH 16/30] feat(discoveryengine): update the api #### discoveryengine:v1 The following keys were added: - schemas.GoogleCloudDiscoveryengineV1AssistantCustomerPolicy.properties.dataProtectionPolicy.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataConnector.properties.dataProtectionPolicy.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataProtectionPolicy (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.dataProtectionPolicy.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1Engine.properties.sessionConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1SessionConfig (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig.properties.thinkingLevel.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.sessionConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSessionConfig (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1betaDataProtectionPolicy (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.dataProtectionPolicy.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.sessionConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSessionConfig (Total Keys: 8) #### discoveryengine:v1alpha The following keys were deleted: - resources.projects.resources.locations.resources.notebooks.methods.batchDelete (Total Keys: 12) - resources.projects.resources.locations.resources.notebooks.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.notebooks.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.notebooks.methods.listRecentlyViewed (Total Keys: 16) - resources.projects.resources.locations.resources.notebooks.methods.share (Total Keys: 12) - resources.projects.resources.locations.resources.notebooks.resources.sources.methods.batchCreate (Total Keys: 12) - resources.projects.resources.locations.resources.notebooks.resources.sources.methods.batchDelete (Total Keys: 12) - resources.projects.resources.locations.resources.notebooks.resources.sources.methods.get (Total Keys: 11) - schemas.GoogleCloudNotebooklmV1alphaAccountAndRole (Total Keys: 4) - schemas.GoogleCloudNotebooklmV1alphaAgentspaceMetadata (Total Keys: 4) - schemas.GoogleCloudNotebooklmV1alphaBatchCreateSourcesRequest (Total Keys: 4) - schemas.GoogleCloudNotebooklmV1alphaBatchCreateSourcesResponse (Total Keys: 4) - schemas.GoogleCloudNotebooklmV1alphaBatchDeleteNotebooksRequest (Total Keys: 4) - schemas.GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest (Total Keys: 4) - schemas.GoogleCloudNotebooklmV1alphaCmekConfig (Total Keys: 3) - schemas.GoogleCloudNotebooklmV1alphaFailureReason (Total Keys: 61) - schemas.GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata (Total Keys: 4) - schemas.GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse (Total Keys: 5) - schemas.GoogleCloudNotebooklmV1alphaNotebook (Total Keys: 22) - schemas.GoogleCloudNotebooklmV1alphaShareNotebookRequest (Total Keys: 5) - schemas.GoogleCloudNotebooklmV1alphaShareNotebookResponse (Total Keys: 2) - schemas.GoogleCloudNotebooklmV1alphaSource (Total Keys: 24) - schemas.GoogleCloudNotebooklmV1alphaUserContent (Total Keys: 26) - schemas.GoogleCloudNotebooklmV1alphaYoutubeMetadata (Total Keys: 6) The following keys were added: - schemas.GoogleCloudDiscoveryengineV1AssistantCustomerPolicy.properties.dataProtectionPolicy.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataConnector.properties.dataProtectionPolicy.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataProtectionPolicy (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.dataProtectionPolicy.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1Engine.properties.sessionConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1SessionConfig (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig.properties.thinkingLevel.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.sessionConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSessionConfig (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1betaDataProtectionPolicy (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.dataProtectionPolicy.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.sessionConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSessionConfig (Total Keys: 8) #### discoveryengine:v1beta The following keys were added: - schemas.GoogleCloudDiscoveryengineV1AssistantCustomerPolicy.properties.dataProtectionPolicy.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataConnector.properties.dataProtectionPolicy.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataProtectionPolicy (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.dataProtectionPolicy.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1Engine.properties.sessionConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1SessionConfig (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig.properties.thinkingLevel.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.sessionConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSessionConfig (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicy.properties.dataProtectionPolicy.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDataProtectionPolicy (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.dataProtectionPolicy.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.sessionConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSessionConfig (Total Keys: 8) --- ...ects.locations.collections.dataStores.html | 25 + ....collections.dataStores.widgetConfigs.html | 6 +- ...ations.collections.engines.assistants.html | 30 + ...rojects.locations.collections.engines.html | 30 + ...ons.collections.engines.widgetConfigs.html | 6 +- ...ine_v1.projects.locations.collections.html | 15 + ...gine_v1.projects.locations.dataStores.html | 25 + ...ts.locations.dataStores.widgetConfigs.html | 6 +- ...discoveryengine_v1.projects.locations.html | 10 + ....collections.dataStores.widgetConfigs.html | 6 +- ...rojects.locations.collections.engines.html | 42 + ...gines.sessions.alphaEvolveExperiments.html | 4 + ...ons.collections.engines.widgetConfigs.html | 6 +- ...ts.locations.dataStores.widgetConfigs.html | 6 +- ..._v1alpha.projects.locations.notebooks.html | 494 ------- ...ects.locations.collections.dataStores.html | 25 + ...ations.collections.engines.assistants.html | 30 + ...rojects.locations.collections.engines.html | 42 + ..._v1beta.projects.locations.dataStores.html | 25 + .../documents/discoveryengine.v1.json | 232 +++- .../documents/discoveryengine.v1alpha.json | 1165 ++++------------- .../documents/discoveryengine.v1beta.json | 207 ++- 22 files changed, 983 insertions(+), 1454 deletions(-) diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html index 36f68cc1d1..1f4b1dbfa3 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html @@ -263,6 +263,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -508,6 +513,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -744,6 +754,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -933,6 +948,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -1104,6 +1124,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. 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 6fd63e3a8f..462b72a687 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html @@ -98,11 +98,12 @@

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`). + modelInfoView: string, Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `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; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector. 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. + END_USER_MOBILE - The end-user model selector view for the Gemini Enterprise mobile app. Returns only mobile-surfaced models, with the mobile default selected. Set explicitly by the mobile client. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -365,6 +366,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. @@ -651,6 +653,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. @@ -936,6 +939,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html index 59012e7522..129b3bfcb0 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html @@ -128,6 +128,11 @@

Method Details

"phrase": "A String", # Required. The raw string content to be banned. }, ], + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Data protection policy to be used for sanitizing file uploads. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. "failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization. "responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response. @@ -181,6 +186,11 @@

Method Details

"phrase": "A String", # Required. The raw string content to be banned. }, ], + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Data protection policy to be used for sanitizing file uploads. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. "failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization. "responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response. @@ -258,6 +268,11 @@

Method Details

"phrase": "A String", # Required. The raw string content to be banned. }, ], + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Data protection policy to be used for sanitizing file uploads. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. "failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization. "responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response. @@ -321,6 +336,11 @@

Method Details

"phrase": "A String", # Required. The raw string content to be banned. }, ], + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Data protection policy to be used for sanitizing file uploads. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. "failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization. "responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response. @@ -392,6 +412,11 @@

Method Details

"phrase": "A String", # Required. The raw string content to be banned. }, ], + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Data protection policy to be used for sanitizing file uploads. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. "failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization. "responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response. @@ -445,6 +470,11 @@

Method Details

"phrase": "A String", # Required. The raw string content to be banned. }, ], + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Data protection policy to be used for sanitizing file uploads. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. "failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization. "responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html index b8bc4fba15..0eeb9254c5 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html @@ -260,6 +260,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "solutionType": "A String", # Required. The solutions of the engine. "updateTime": "A String", # Output only. Timestamp the Recommendation Engine was last updated. } @@ -447,6 +453,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "solutionType": "A String", # Required. The solutions of the engine. "updateTime": "A String", # Output only. Timestamp the Recommendation Engine was last updated. }
@@ -610,6 +622,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "solutionType": "A String", # Required. The solutions of the engine. "updateTime": "A String", # Output only. Timestamp the Recommendation Engine was last updated. }, @@ -745,6 +763,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "solutionType": "A String", # Required. The solutions of the engine. "updateTime": "A String", # Output only. Timestamp the Recommendation Engine was last updated. } @@ -862,6 +886,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "solutionType": "A String", # Required. The solutions of the engine. "updateTime": "A String", # Output only. Timestamp the Recommendation Engine was last updated. }
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 af07086ee7..bcb2d12089 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html @@ -98,11 +98,12 @@

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`). + modelInfoView: string, Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `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; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector. 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. + END_USER_MOBILE - The end-user model selector view for the Gemini Enterprise mobile app. Returns only mobile-surfaced models, with the mobile default selected. Set explicitly by the mobile client. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -365,6 +366,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. @@ -651,6 +653,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. @@ -936,6 +939,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.html index 51ba144f8b..f47fd568ec 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.html @@ -230,6 +230,11 @@

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. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the connector. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "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. 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. @@ -570,6 +575,11 @@

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. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the connector. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "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. 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. @@ -816,6 +826,11 @@

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. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the connector. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "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. 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. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html index cf56da7b4a..2eebd1ace1 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html @@ -255,6 +255,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -500,6 +505,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -736,6 +746,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -925,6 +940,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -1096,6 +1116,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html index 525cba62cc..0dbac1dedd 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html @@ -98,11 +98,12 @@

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`). + modelInfoView: string, Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `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; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector. 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. + END_USER_MOBILE - The end-user model selector view for the Gemini Enterprise mobile app. Returns only mobile-surfaced models, with the mobile default selected. Set explicitly by the mobile client. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -365,6 +366,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. @@ -651,6 +653,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. @@ -936,6 +939,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.html b/docs/dyn/discoveryengine_v1.projects.locations.html index cd27381ce3..98b6d4385e 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.html @@ -336,6 +336,11 @@

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. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the connector. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "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. 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. @@ -612,6 +617,11 @@

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. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the connector. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "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. 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. 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 80b2d0c0ca..41c031ebfb 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html @@ -98,11 +98,12 @@

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`). + modelInfoView: string, Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `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; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector. 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. + END_USER_MOBILE - The end-user model selector view for the Gemini Enterprise mobile app. Returns only mobile-surfaced models, with the mobile default selected. Set explicitly by the mobile client. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -370,6 +371,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. @@ -661,6 +663,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. @@ -951,6 +954,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html index b96c4b324f..cf0befc857 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html @@ -290,6 +290,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "similarDocumentsConfig": { # Additional config specs for a `similar-items` engine. # Additional config specs for a `similar-items` engine. }, "solutionType": "A String", # Required. The solutions of the engine. @@ -486,6 +492,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "similarDocumentsConfig": { # Additional config specs for a `similar-items` engine. # Additional config specs for a `similar-items` engine. }, "solutionType": "A String", # Required. The solutions of the engine. @@ -706,6 +718,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "similarDocumentsConfig": { # Additional config specs for a `similar-items` engine. # Additional config specs for a `similar-items` engine. }, "solutionType": "A String", # Required. The solutions of the engine. @@ -850,6 +868,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "similarDocumentsConfig": { # Additional config specs for a `similar-items` engine. # Additional config specs for a `similar-items` engine. }, "solutionType": "A String", # Required. The solutions of the engine. @@ -976,6 +1000,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "similarDocumentsConfig": { # Additional config specs for a `similar-items` engine. # Additional config specs for a `similar-items` engine. }, "solutionType": "A String", # Required. The solutions of the engine. @@ -1114,6 +1144,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "similarDocumentsConfig": { # Additional config specs for a `similar-items` engine. # Additional config specs for a `similar-items` engine. }, "solutionType": "A String", # Required. The solutions of the engine. @@ -1252,6 +1288,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "similarDocumentsConfig": { # Additional config specs for a `similar-items` engine. # Additional config specs for a `similar-items` engine. }, "solutionType": "A String", # Required. The solutions of the engine. 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 13adba5593..bd19cfc15a 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 @@ -209,6 +209,7 @@

Method Details

"models": [ # Optional. Per-model configuration. See `ModelConfig` for details. If left unset, the server selects a default model. { # Per-model configuration. Mutually exclusive with `model_mixture` and `model`: when `models` is set, both `model_mixture` and `model` must be left unset. The same allowed-model list and at-most-2-models rule as for `model_mixture` apply. In addition, each entry may specify a per-model `temperature` for LLM sampling. Unlike `model_mixture`, weights here are *relative*: only their ratios matter (the server normalizes them), so callers may use any positive numbers without having to ensure they sum to 1.0. "name": "A String", # Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models. + "thinkingLevel": "A String", # Optional. Sent as Vertex `ThinkingConfig.thinking_level`. "weight": 3.14, # Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT. }, ], @@ -257,6 +258,7 @@

Method Details

"models": [ # Optional. Per-model configuration. See `ModelConfig` for details. If left unset, the server selects a default model. { # Per-model configuration. Mutually exclusive with `model_mixture` and `model`: when `models` is set, both `model_mixture` and `model` must be left unset. The same allowed-model list and at-most-2-models rule as for `model_mixture` apply. In addition, each entry may specify a per-model `temperature` for LLM sampling. Unlike `model_mixture`, weights here are *relative*: only their ratios matter (the server normalizes them), so callers may use any positive numbers without having to ensure they sum to 1.0. "name": "A String", # Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models. + "thinkingLevel": "A String", # Optional. Sent as Vertex `ThinkingConfig.thinking_level`. "weight": 3.14, # Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT. }, ], @@ -330,6 +332,7 @@

Method Details

"models": [ # Optional. Per-model configuration. See `ModelConfig` for details. If left unset, the server selects a default model. { # Per-model configuration. Mutually exclusive with `model_mixture` and `model`: when `models` is set, both `model_mixture` and `model` must be left unset. The same allowed-model list and at-most-2-models rule as for `model_mixture` apply. In addition, each entry may specify a per-model `temperature` for LLM sampling. Unlike `model_mixture`, weights here are *relative*: only their ratios matter (the server normalizes them), so callers may use any positive numbers without having to ensure they sum to 1.0. "name": "A String", # Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models. + "thinkingLevel": "A String", # Optional. Sent as Vertex `ThinkingConfig.thinking_level`. "weight": 3.14, # Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT. }, ], @@ -389,6 +392,7 @@

Method Details

"models": [ # Optional. Per-model configuration. See `ModelConfig` for details. If left unset, the server selects a default model. { # Per-model configuration. Mutually exclusive with `model_mixture` and `model`: when `models` is set, both `model_mixture` and `model` must be left unset. The same allowed-model list and at-most-2-models rule as for `model_mixture` apply. In addition, each entry may specify a per-model `temperature` for LLM sampling. Unlike `model_mixture`, weights here are *relative*: only their ratios matter (the server normalizes them), so callers may use any positive numbers without having to ensure they sum to 1.0. "name": "A String", # Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models. + "thinkingLevel": "A String", # Optional. Sent as Vertex `ThinkingConfig.thinking_level`. "weight": 3.14, # Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT. }, ], 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 e0b777d21d..16287ad572 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html @@ -98,11 +98,12 @@

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`). + modelInfoView: string, Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `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; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector. 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. + END_USER_MOBILE - The end-user model selector view for the Gemini Enterprise mobile app. Returns only mobile-surfaced models, with the mobile default selected. Set explicitly by the mobile client. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -370,6 +371,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. @@ -661,6 +663,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. @@ -951,6 +954,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html index 087bd17cf7..2b297c739f 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html @@ -98,11 +98,12 @@

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`). + modelInfoView: string, Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `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; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector. 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. + END_USER_MOBILE - The end-user model selector view for the Gemini Enterprise mobile app. Returns only mobile-surfaced models, with the mobile default selected. Set explicitly by the mobile client. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -370,6 +371,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. @@ -661,6 +663,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. @@ -951,6 +954,7 @@

Method Details

"description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). + "iconUrl": "A String", # Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. "isPreview": True or False, # Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. "label": "A String", # Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. "modelId": "A String", # Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.html index 59e85fabce..9d17aacf37 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.html @@ -79,507 +79,13 @@

Instance Methods

Returns the audioOverviews Resource.

-

- sources() -

-

Returns the sources Resource.

- -

- batchDelete(parent, body=None, x__xgafv=None)

-

Batch deletes Notebooks.

close()

Close httplib2 connections.

-

- create(parent, body=None, x__xgafv=None)

-

Creates a notebook.

-

- get(name, x__xgafv=None)

-

Gets a notebook.

-

- listRecentlyViewed(parent, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists the notebooks ordered by last view time.

-

- listRecentlyViewed_next(previous_request, previous_response)

-

Retrieves the next page of results.

-

- share(name, body=None, x__xgafv=None)

-

Shares a notebook to other accounts.

Method Details

-
- batchDelete(parent, body=None, x__xgafv=None) -
Batch deletes Notebooks.
-
-Args:
-  parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}`. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request for NotebookService.BatchDeleteNotebooks method.
-  "names": [ # Required. Full resource names of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`.
-    "A String",
-  ],
-}
-
-  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.
-
- create(parent, body=None, x__xgafv=None) -
Creates a notebook.
-
-Args:
-  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Notebook is a resource where users can store their content (as sources) and interacts with the content.
-  "cmekConfig": { # Customer-managed encryption configuration for Notebooks. # Output only. CMEK-related information for the Notebook.
-    "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
-  },
-  "emoji": "A String", # Output only. The emoji of the notebook.
-  "metadata": { # Metadata for a notebook. # Output only. The metadata of the notebook.
-    "createTime": "A String", # The time at which this project was created.
-    "isShareable": True or False, # True if the project is shareable.
-    "isShared": True or False, # True if this project is currently shared with other people, false otherwise.
-    "lastViewed": "A String", # A timestamp indicating the time that the current in session user has last viewed the project.
-  },
-  "name": "A String", # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.
-  "notebookId": "A String", # Output only. Notebook id, which is the last segment of the notebook's resource name.
-  "sources": [ # Output only. List of sources in the notebook. This is an output only field.
-    { # Source represents a single source of content.
-      "metadata": { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
-        "agentspaceMetadata": { # Metadata about an agentspace source. # Metadata for an agentspace source.
-          "documentName": "A String", # Output only. The full document name in Agentspace.
-          "documentTitle": "A String", # Output only. The title of the document.
-        },
-        "googleDocsMetadata": { # Metadata about a google doc source. # Metadata for a google doc source.
-          "documentId": "A String", # Output only. The document id of the google doc.
-          "revisionId": "A String", # Output only. Revision id for the doc.
-        },
-        "sourceAddedTimestamp": "A String", # The timestamp the source was added.
-        "tokenCount": 42, # The number of tokens in the source.
-        "wordCount": 42, # The word count of the source.
-        "youtubeMetadata": { # Metadata about a youtube video source. # Metadata for a youtube video source.
-          "channelName": "A String", # Output only. The channel name of the youtube video.
-          "videoId": "A String", # Output only. The id of the youtube video.
-        },
-      },
-      "name": "A String", # Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
-      "settings": { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
-        "failureReason": { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
-          "audioTranscriptionError": { # An audio file transcription specific error. # An audio file transcription specific error.
-            "languageDetectionFailed": { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
-            },
-            "noAudioDetected": { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
-            },
-          },
-          "domainBlocked": { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
-          },
-          "googleDriveError": { # A google drive specific error. # A google drive specific error.
-            "downloadPrevented": { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
-            },
-          },
-          "ingestionError": { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
-          },
-          "mimeTypeBlocked": { # Indicates that the source MIME type is blocked. # Indicates that the source MIME type is blocked.
-          },
-          "paywallError": { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
-          },
-          "policyCheckFailed": { # Indicates that the policy check failed. # Indicates that the policy check failed.
-          },
-          "sourceEmpty": { # Indicates that the source is empty. # Indicates that the source is empty.
-          },
-          "sourceLimitExceeded": { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
-          },
-          "sourceTooLong": { # Indicates source word count exceeded the user's limit. # Indicates source word count exceeded the user's limit.
-            "wordCount": 42, # The number of words in the source.
-            "wordLimit": 42, # The word count limit for the current user at the time of the upload.
-          },
-          "sourceUnreachable": { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
-            "errorDetails": "A String", # Describes why the source is unreachable.
-          },
-          "unknown": { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
-          },
-          "uploadError": { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
-          },
-          "youtubeError": { # A youtube specific error. # A youtube specific error.
-            "videoDeleted": { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
-            },
-          },
-        },
-        "status": "A String", # Status of the source.
-      },
-      "sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Output only. Source id, which is the last segment of the source's resource name.
-        "id": "A String", # The id of the source.
-      },
-      "title": "A String", # Optional. Title of the source.
-    },
-  ],
-  "title": "A String", # Optional. The title of the notebook.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Notebook is a resource where users can store their content (as sources) and interacts with the content.
-  "cmekConfig": { # Customer-managed encryption configuration for Notebooks. # Output only. CMEK-related information for the Notebook.
-    "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
-  },
-  "emoji": "A String", # Output only. The emoji of the notebook.
-  "metadata": { # Metadata for a notebook. # Output only. The metadata of the notebook.
-    "createTime": "A String", # The time at which this project was created.
-    "isShareable": True or False, # True if the project is shareable.
-    "isShared": True or False, # True if this project is currently shared with other people, false otherwise.
-    "lastViewed": "A String", # A timestamp indicating the time that the current in session user has last viewed the project.
-  },
-  "name": "A String", # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.
-  "notebookId": "A String", # Output only. Notebook id, which is the last segment of the notebook's resource name.
-  "sources": [ # Output only. List of sources in the notebook. This is an output only field.
-    { # Source represents a single source of content.
-      "metadata": { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
-        "agentspaceMetadata": { # Metadata about an agentspace source. # Metadata for an agentspace source.
-          "documentName": "A String", # Output only. The full document name in Agentspace.
-          "documentTitle": "A String", # Output only. The title of the document.
-        },
-        "googleDocsMetadata": { # Metadata about a google doc source. # Metadata for a google doc source.
-          "documentId": "A String", # Output only. The document id of the google doc.
-          "revisionId": "A String", # Output only. Revision id for the doc.
-        },
-        "sourceAddedTimestamp": "A String", # The timestamp the source was added.
-        "tokenCount": 42, # The number of tokens in the source.
-        "wordCount": 42, # The word count of the source.
-        "youtubeMetadata": { # Metadata about a youtube video source. # Metadata for a youtube video source.
-          "channelName": "A String", # Output only. The channel name of the youtube video.
-          "videoId": "A String", # Output only. The id of the youtube video.
-        },
-      },
-      "name": "A String", # Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
-      "settings": { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
-        "failureReason": { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
-          "audioTranscriptionError": { # An audio file transcription specific error. # An audio file transcription specific error.
-            "languageDetectionFailed": { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
-            },
-            "noAudioDetected": { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
-            },
-          },
-          "domainBlocked": { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
-          },
-          "googleDriveError": { # A google drive specific error. # A google drive specific error.
-            "downloadPrevented": { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
-            },
-          },
-          "ingestionError": { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
-          },
-          "mimeTypeBlocked": { # Indicates that the source MIME type is blocked. # Indicates that the source MIME type is blocked.
-          },
-          "paywallError": { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
-          },
-          "policyCheckFailed": { # Indicates that the policy check failed. # Indicates that the policy check failed.
-          },
-          "sourceEmpty": { # Indicates that the source is empty. # Indicates that the source is empty.
-          },
-          "sourceLimitExceeded": { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
-          },
-          "sourceTooLong": { # Indicates source word count exceeded the user's limit. # Indicates source word count exceeded the user's limit.
-            "wordCount": 42, # The number of words in the source.
-            "wordLimit": 42, # The word count limit for the current user at the time of the upload.
-          },
-          "sourceUnreachable": { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
-            "errorDetails": "A String", # Describes why the source is unreachable.
-          },
-          "unknown": { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
-          },
-          "uploadError": { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
-          },
-          "youtubeError": { # A youtube specific error. # A youtube specific error.
-            "videoDeleted": { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
-            },
-          },
-        },
-        "status": "A String", # Status of the source.
-      },
-      "sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Output only. Source id, which is the last segment of the source's resource name.
-        "id": "A String", # The id of the source.
-      },
-      "title": "A String", # Optional. Title of the source.
-    },
-  ],
-  "title": "A String", # Optional. The title of the notebook.
-}
-
- -
- get(name, x__xgafv=None) -
Gets a notebook.
-
-Args:
-  name: string, Required. Full resource name of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Notebook is a resource where users can store their content (as sources) and interacts with the content.
-  "cmekConfig": { # Customer-managed encryption configuration for Notebooks. # Output only. CMEK-related information for the Notebook.
-    "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
-  },
-  "emoji": "A String", # Output only. The emoji of the notebook.
-  "metadata": { # Metadata for a notebook. # Output only. The metadata of the notebook.
-    "createTime": "A String", # The time at which this project was created.
-    "isShareable": True or False, # True if the project is shareable.
-    "isShared": True or False, # True if this project is currently shared with other people, false otherwise.
-    "lastViewed": "A String", # A timestamp indicating the time that the current in session user has last viewed the project.
-  },
-  "name": "A String", # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.
-  "notebookId": "A String", # Output only. Notebook id, which is the last segment of the notebook's resource name.
-  "sources": [ # Output only. List of sources in the notebook. This is an output only field.
-    { # Source represents a single source of content.
-      "metadata": { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
-        "agentspaceMetadata": { # Metadata about an agentspace source. # Metadata for an agentspace source.
-          "documentName": "A String", # Output only. The full document name in Agentspace.
-          "documentTitle": "A String", # Output only. The title of the document.
-        },
-        "googleDocsMetadata": { # Metadata about a google doc source. # Metadata for a google doc source.
-          "documentId": "A String", # Output only. The document id of the google doc.
-          "revisionId": "A String", # Output only. Revision id for the doc.
-        },
-        "sourceAddedTimestamp": "A String", # The timestamp the source was added.
-        "tokenCount": 42, # The number of tokens in the source.
-        "wordCount": 42, # The word count of the source.
-        "youtubeMetadata": { # Metadata about a youtube video source. # Metadata for a youtube video source.
-          "channelName": "A String", # Output only. The channel name of the youtube video.
-          "videoId": "A String", # Output only. The id of the youtube video.
-        },
-      },
-      "name": "A String", # Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
-      "settings": { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
-        "failureReason": { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
-          "audioTranscriptionError": { # An audio file transcription specific error. # An audio file transcription specific error.
-            "languageDetectionFailed": { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
-            },
-            "noAudioDetected": { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
-            },
-          },
-          "domainBlocked": { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
-          },
-          "googleDriveError": { # A google drive specific error. # A google drive specific error.
-            "downloadPrevented": { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
-            },
-          },
-          "ingestionError": { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
-          },
-          "mimeTypeBlocked": { # Indicates that the source MIME type is blocked. # Indicates that the source MIME type is blocked.
-          },
-          "paywallError": { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
-          },
-          "policyCheckFailed": { # Indicates that the policy check failed. # Indicates that the policy check failed.
-          },
-          "sourceEmpty": { # Indicates that the source is empty. # Indicates that the source is empty.
-          },
-          "sourceLimitExceeded": { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
-          },
-          "sourceTooLong": { # Indicates source word count exceeded the user's limit. # Indicates source word count exceeded the user's limit.
-            "wordCount": 42, # The number of words in the source.
-            "wordLimit": 42, # The word count limit for the current user at the time of the upload.
-          },
-          "sourceUnreachable": { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
-            "errorDetails": "A String", # Describes why the source is unreachable.
-          },
-          "unknown": { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
-          },
-          "uploadError": { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
-          },
-          "youtubeError": { # A youtube specific error. # A youtube specific error.
-            "videoDeleted": { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
-            },
-          },
-        },
-        "status": "A String", # Status of the source.
-      },
-      "sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Output only. Source id, which is the last segment of the source's resource name.
-        "id": "A String", # The id of the source.
-      },
-      "title": "A String", # Optional. Title of the source.
-    },
-  ],
-  "title": "A String", # Optional. The title of the notebook.
-}
-
- -
- listRecentlyViewed(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the notebooks ordered by last view time.
-
-Args:
-  parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}`. (required)
-  pageSize: integer, Optional. Maximum number of Notebooks to return. If unspecified, defaults to "500". The maximum allowed value is "500". If this field is negative, will use the default value.
-  pageToken: string, Optional. The page token, provide this to retrieve the subsequent page.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for NotebookService.ListRecentlyViewedNotebooks method.
-  "nextPageToken": "A String", # The page token, provide this to retrieve the subsequent page.
-  "notebooks": [ # The list of recently viewed notebooks.
-    { # Notebook is a resource where users can store their content (as sources) and interacts with the content.
-      "cmekConfig": { # Customer-managed encryption configuration for Notebooks. # Output only. CMEK-related information for the Notebook.
-        "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
-      },
-      "emoji": "A String", # Output only. The emoji of the notebook.
-      "metadata": { # Metadata for a notebook. # Output only. The metadata of the notebook.
-        "createTime": "A String", # The time at which this project was created.
-        "isShareable": True or False, # True if the project is shareable.
-        "isShared": True or False, # True if this project is currently shared with other people, false otherwise.
-        "lastViewed": "A String", # A timestamp indicating the time that the current in session user has last viewed the project.
-      },
-      "name": "A String", # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.
-      "notebookId": "A String", # Output only. Notebook id, which is the last segment of the notebook's resource name.
-      "sources": [ # Output only. List of sources in the notebook. This is an output only field.
-        { # Source represents a single source of content.
-          "metadata": { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
-            "agentspaceMetadata": { # Metadata about an agentspace source. # Metadata for an agentspace source.
-              "documentName": "A String", # Output only. The full document name in Agentspace.
-              "documentTitle": "A String", # Output only. The title of the document.
-            },
-            "googleDocsMetadata": { # Metadata about a google doc source. # Metadata for a google doc source.
-              "documentId": "A String", # Output only. The document id of the google doc.
-              "revisionId": "A String", # Output only. Revision id for the doc.
-            },
-            "sourceAddedTimestamp": "A String", # The timestamp the source was added.
-            "tokenCount": 42, # The number of tokens in the source.
-            "wordCount": 42, # The word count of the source.
-            "youtubeMetadata": { # Metadata about a youtube video source. # Metadata for a youtube video source.
-              "channelName": "A String", # Output only. The channel name of the youtube video.
-              "videoId": "A String", # Output only. The id of the youtube video.
-            },
-          },
-          "name": "A String", # Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
-          "settings": { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
-            "failureReason": { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
-              "audioTranscriptionError": { # An audio file transcription specific error. # An audio file transcription specific error.
-                "languageDetectionFailed": { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
-                },
-                "noAudioDetected": { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
-                },
-              },
-              "domainBlocked": { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
-              },
-              "googleDriveError": { # A google drive specific error. # A google drive specific error.
-                "downloadPrevented": { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
-                },
-              },
-              "ingestionError": { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
-              },
-              "mimeTypeBlocked": { # Indicates that the source MIME type is blocked. # Indicates that the source MIME type is blocked.
-              },
-              "paywallError": { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
-              },
-              "policyCheckFailed": { # Indicates that the policy check failed. # Indicates that the policy check failed.
-              },
-              "sourceEmpty": { # Indicates that the source is empty. # Indicates that the source is empty.
-              },
-              "sourceLimitExceeded": { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
-              },
-              "sourceTooLong": { # Indicates source word count exceeded the user's limit. # Indicates source word count exceeded the user's limit.
-                "wordCount": 42, # The number of words in the source.
-                "wordLimit": 42, # The word count limit for the current user at the time of the upload.
-              },
-              "sourceUnreachable": { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
-                "errorDetails": "A String", # Describes why the source is unreachable.
-              },
-              "unknown": { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
-              },
-              "uploadError": { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
-              },
-              "youtubeError": { # A youtube specific error. # A youtube specific error.
-                "videoDeleted": { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
-                },
-              },
-            },
-            "status": "A String", # Status of the source.
-          },
-          "sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Output only. Source id, which is the last segment of the source's resource name.
-            "id": "A String", # The id of the source.
-          },
-          "title": "A String", # Optional. Title of the source.
-        },
-      ],
-      "title": "A String", # Optional. The title of the notebook.
-    },
-  ],
-}
-
- -
- listRecentlyViewed_next(previous_request, previous_response) -
Retrieves the next page of results.
-
-Args:
-  previous_request: The request for the previous page. (required)
-  previous_response: The response from the request for the previous page. (required)
-
-Returns:
-  A request object that you can call 'execute()' on to request the next
-  page. Returns None if there are no more items in the collection.
-
-
- -
- share(name, body=None, x__xgafv=None) -
Shares a notebook to other accounts.
-
-Args:
-  name: string, Required. Full resource name of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request for NotebookService.ShareNotebook method.
-  "accountAndRoles": [ # Required. The list of accounts and roles to share the notebook with.
-    { # Account and role information.
-      "email": "A String", # Required. The email address associated with the account.
-      "role": "A String", # Required. The role in the notebook.
-    },
-  ],
-  "notifyViaEmail": True or False, # Required. Whether to notify the shared users via email.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for NotebookService.ShareNotebook method.
-}
-
- \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html index 67bf2619d7..fd4787fa29 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html @@ -258,6 +258,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -509,6 +514,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -751,6 +761,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -946,6 +961,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -1123,6 +1143,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html index 74fbaad92a..ceb9a5fe66 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html @@ -128,6 +128,11 @@

Method Details

"phrase": "A String", # Required. The raw string content to be banned. }, ], + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Data protection policy to be used for sanitizing file uploads. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. "failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization. "responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response. @@ -181,6 +186,11 @@

Method Details

"phrase": "A String", # Required. The raw string content to be banned. }, ], + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Data protection policy to be used for sanitizing file uploads. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. "failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization. "responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response. @@ -258,6 +268,11 @@

Method Details

"phrase": "A String", # Required. The raw string content to be banned. }, ], + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Data protection policy to be used for sanitizing file uploads. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. "failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization. "responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response. @@ -321,6 +336,11 @@

Method Details

"phrase": "A String", # Required. The raw string content to be banned. }, ], + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Data protection policy to be used for sanitizing file uploads. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. "failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization. "responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response. @@ -392,6 +412,11 @@

Method Details

"phrase": "A String", # Required. The raw string content to be banned. }, ], + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Data protection policy to be used for sanitizing file uploads. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. "failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization. "responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response. @@ -445,6 +470,11 @@

Method Details

"phrase": "A String", # Required. The raw string content to be banned. }, ], + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Data protection policy to be used for sanitizing file uploads. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses. # Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. "failureMode": "A String", # Optional. Defines the failure mode for Model Armor sanitization. "responseTemplate": "A String", # Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html index 6115925cbe..f6f8ce3d11 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html @@ -264,6 +264,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "solutionType": "A String", # Required. The solutions of the engine. "updateTime": "A String", # Output only. Timestamp the Recommendation Engine was last updated. } @@ -451,6 +457,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "solutionType": "A String", # Required. The solutions of the engine. "updateTime": "A String", # Output only. Timestamp the Recommendation Engine was last updated. }
@@ -614,6 +626,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "solutionType": "A String", # Required. The solutions of the engine. "updateTime": "A String", # Output only. Timestamp the Recommendation Engine was last updated. }, @@ -749,6 +767,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "solutionType": "A String", # Required. The solutions of the engine. "updateTime": "A String", # Output only. Timestamp the Recommendation Engine was last updated. } @@ -866,6 +890,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "solutionType": "A String", # Required. The solutions of the engine. "updateTime": "A String", # Output only. Timestamp the Recommendation Engine was last updated. }
@@ -995,6 +1025,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "solutionType": "A String", # Required. The solutions of the engine. "updateTime": "A String", # Output only. Timestamp the Recommendation Engine was last updated. }
@@ -1124,6 +1160,12 @@

Method Details

], "searchTier": "A String", # The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. }, + "sessionConfig": { # Configuration for the session. # Optional. Non-empty default. Session config for the engine. + "sessionManagementPolicy": "A String", # Optional. Session management policy that defines who will manage the session. + "sessionTtl": { # Defines the TTL for sessions. # Optional. The TTL for the session. If unset, the default value is 60 days. + "days": 42, # Defines the number of days for session TTL. + }, + }, "solutionType": "A String", # Required. The solutions of the engine. "updateTime": "A String", # Output only. Timestamp the Recommendation Engine was last updated. }
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html index 0c5e2b6321..0e77add2a4 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html @@ -250,6 +250,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -501,6 +506,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -743,6 +753,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -938,6 +953,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -1115,6 +1135,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index 189d3cc329..9300349225 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -3952,16 +3952,18 @@ "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`).", +"description": "Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `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; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector.", "enum": [ "MODEL_INFO_VIEW_UNSPECIFIED", "END_USER_WEB", -"ADMIN" +"ADMIN", +"END_USER_MOBILE" ], "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." +"The Cloud Console admin \"Feature Control\" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated.", +"The end-user model selector view for the Gemini Enterprise mobile app. Returns only mobile-surfaced models, with the mobile default selected. Set explicitly by the mobile client." ], "location": "query", "type": "string" @@ -5970,16 +5972,18 @@ "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`).", +"description": "Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `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; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector.", "enum": [ "MODEL_INFO_VIEW_UNSPECIFIED", "END_USER_WEB", -"ADMIN" +"ADMIN", +"END_USER_MOBILE" ], "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." +"The Cloud Console admin \"Feature Control\" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated.", +"The end-user model selector view for the Gemini Enterprise mobile app. Returns only mobile-surfaced models, with the mobile default selected. Set explicitly by the mobile client." ], "location": "query", "type": "string" @@ -8799,16 +8803,18 @@ "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`).", +"description": "Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `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; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector.", "enum": [ "MODEL_INFO_VIEW_UNSPECIFIED", "END_USER_WEB", -"ADMIN" +"ADMIN", +"END_USER_MOBILE" ], "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." +"The Cloud Console admin \"Feature Control\" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated.", +"The end-user model selector view for the Gemini Enterprise mobile app. Returns only mobile-surfaced models, with the mobile default selected. Set explicitly by the mobile client." ], "location": "query", "type": "string" @@ -9931,7 +9937,7 @@ } } }, -"revision": "20260831", +"revision": "20260908", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "A2aV1APIKeySecurityScheme": { @@ -13354,6 +13360,10 @@ }, "type": "array" }, +"dataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1DataProtectionPolicy", +"description": "Optional. Data protection policy to be used for sanitizing file uploads." +}, "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig", "description": "Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses." @@ -15485,6 +15495,10 @@ "readOnly": true, "type": "string" }, +"dataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1DataProtectionPolicy", +"description": "Optional. Specifies the data protection policy for the connector." +}, "dataSource": { "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" @@ -15895,6 +15909,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DataProtectionPolicy": { +"description": "Contains the data protection policy config for a DataStore or a connector.", +"id": "GoogleCloudDiscoveryengineV1DataProtectionPolicy", +"properties": { +"sensitiveDataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1DataProtectionPolicySensitiveDataProtectionPolicy", +"description": "Optional. Specifies the sensitive data protection policy for the connector source." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataProtectionPolicySensitiveDataProtectionPolicy": { +"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.", +"id": "GoogleCloudDiscoveryengineV1DataProtectionPolicySensitiveDataProtectionPolicy", +"properties": { +"policy": { +"description": "Optional. Specifies the resource name of the Sensitive Data Protection content policy.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DataStore": { "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStore", @@ -15961,6 +15997,10 @@ "readOnly": true, "type": "string" }, +"dataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1DataProtectionPolicy", +"description": "Optional. Specifies the data protection policy for the data store." +}, "defaultSchemaId": { "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, @@ -17042,6 +17082,10 @@ "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, +"sessionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1SessionConfig", +"description": "Optional. Non-empty default. Session config for the engine." +}, "solutionType": { "description": "Required. The solutions of the engine.", "enum": [ @@ -21561,6 +21605,43 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1SessionConfig": { +"description": "Configuration for the session.", +"id": "GoogleCloudDiscoveryengineV1SessionConfig", +"properties": { +"sessionManagementPolicy": { +"description": "Optional. Session management policy that defines who will manage the session.", +"enum": [ +"SESSION_MANAGEMENT_POLICY_UNSPECIFIED", +"NOT_MANAGED", +"VERTEX_AI_MANAGED" +], +"enumDescriptions": [ +"Default value.", +"The session will be managed by the customer.", +"Sessions multi-tenancy will be controlled by Google using 1P or 3P identity providers." +], +"type": "string" +}, +"sessionTtl": { +"$ref": "GoogleCloudDiscoveryengineV1SessionConfigSessionTtl", +"description": "Optional. The TTL for the session. If unset, the default value is 60 days." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1SessionConfigSessionTtl": { +"description": "Defines the TTL for sessions.", +"id": "GoogleCloudDiscoveryengineV1SessionConfigSessionTtl", +"properties": { +"days": { +"description": "Defines the number of days for session TTL.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1SessionTurn": { "description": "Represents a turn, including a query from the user and a answer from service.", "id": "GoogleCloudDiscoveryengineV1SessionTurn", @@ -23490,6 +23571,11 @@ false "readOnly": true, "type": "string" }, +"iconUrl": { +"description": "Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing.", +"readOnly": true, +"type": "string" +}, "isPreview": { "description": "Output only. Whether the model is currently in preview. Clients should surface this via a \"Preview\" badge in the selector UI.", "readOnly": true, @@ -24046,6 +24132,24 @@ false "description": "Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models.", "type": "string" }, +"thinkingLevel": { +"description": "Optional. Sent as Vertex `ThinkingConfig.thinking_level`.", +"enum": [ +"THINKING_LEVEL_UNSPECIFIED", +"MINIMAL", +"LOW", +"MEDIUM", +"HIGH" +], +"enumDescriptions": [ +"Unset. The model applies its own default, which is not the same level for every model.", +"Least thinking. Not offered by every model.", +"Vertex `LOW`.", +"Vertex `MEDIUM`.", +"Vertex `HIGH`." +], +"type": "string" +}, "weight": { "description": "Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT.", "format": "float", @@ -27844,6 +27948,10 @@ false "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, +"sessionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSessionConfig", +"description": "Optional. Non-empty default. Session config for the engine." +}, "similarDocumentsConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", "description": "Additional config specs for a `similar-items` engine." @@ -31368,6 +31476,43 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaSessionConfig": { +"description": "Configuration for the session.", +"id": "GoogleCloudDiscoveryengineV1alphaSessionConfig", +"properties": { +"sessionManagementPolicy": { +"description": "Optional. Session management policy that defines who will manage the session.", +"enum": [ +"SESSION_MANAGEMENT_POLICY_UNSPECIFIED", +"NOT_MANAGED", +"VERTEX_AI_MANAGED" +], +"enumDescriptions": [ +"Default value.", +"The session will be managed by the customer.", +"Sessions multi-tenancy will be controlled by Google using 1P or 3P identity providers." +], +"type": "string" +}, +"sessionTtl": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSessionConfigSessionTtl", +"description": "Optional. The TTL for the session. If unset, the default value is 60 days." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSessionConfigSessionTtl": { +"description": "Defines the TTL for sessions.", +"id": "GoogleCloudDiscoveryengineV1alphaSessionConfigSessionTtl", +"properties": { +"days": { +"description": "Defines the number of days for session TTL.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSessionTurn": { "description": "Represents a turn, including a query from the user and a answer from service.", "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", @@ -32594,6 +32739,28 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDataProtectionPolicy": { +"description": "Contains the data protection policy config for a DataStore or a connector.", +"id": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicy", +"properties": { +"sensitiveDataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicySensitiveDataProtectionPolicy", +"description": "Optional. Specifies the sensitive data protection policy for the connector source." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataProtectionPolicySensitiveDataProtectionPolicy": { +"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.", +"id": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicySensitiveDataProtectionPolicy", +"properties": { +"policy": { +"description": "Optional. Specifies the resource name of the Sensitive Data Protection content policy.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDataStore": { "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1betaDataStore", @@ -32660,6 +32827,10 @@ false "readOnly": true, "type": "string" }, +"dataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicy", +"description": "Optional. Specifies the data protection policy for the data store." +}, "defaultSchemaId": { "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, @@ -33423,6 +33594,10 @@ false "$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, +"sessionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaSessionConfig", +"description": "Optional. Non-empty default. Session config for the engine." +}, "solutionType": { "description": "Required. The solutions of the engine.", "enum": [ @@ -35935,6 +36110,43 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaSessionConfig": { +"description": "Configuration for the session.", +"id": "GoogleCloudDiscoveryengineV1betaSessionConfig", +"properties": { +"sessionManagementPolicy": { +"description": "Optional. Session management policy that defines who will manage the session.", +"enum": [ +"SESSION_MANAGEMENT_POLICY_UNSPECIFIED", +"NOT_MANAGED", +"VERTEX_AI_MANAGED" +], +"enumDescriptions": [ +"Default value.", +"The session will be managed by the customer.", +"Sessions multi-tenancy will be controlled by Google using 1P or 3P identity providers." +], +"type": "string" +}, +"sessionTtl": { +"$ref": "GoogleCloudDiscoveryengineV1betaSessionConfigSessionTtl", +"description": "Optional. The TTL for the session. If unset, the default value is 60 days." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSessionConfigSessionTtl": { +"description": "Defines the TTL for sessions.", +"id": "GoogleCloudDiscoveryengineV1betaSessionConfigSessionTtl", +"properties": { +"days": { +"description": "Defines the number of days for session TTL.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata": { "description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 661b7ee7c3..74435d023c 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -5404,16 +5404,18 @@ "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`).", +"description": "Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `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; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector.", "enum": [ "MODEL_INFO_VIEW_UNSPECIFIED", "END_USER_WEB", -"ADMIN" +"ADMIN", +"END_USER_MOBILE" ], "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." +"The Cloud Console admin \"Feature Control\" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated.", +"The end-user model selector view for the Gemini Enterprise mobile app. Returns only mobile-surfaced models, with the mobile default selected. Set explicitly by the mobile client." ], "location": "query", "type": "string" @@ -8191,16 +8193,18 @@ "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`).", +"description": "Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `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; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector.", "enum": [ "MODEL_INFO_VIEW_UNSPECIFIED", "END_USER_WEB", -"ADMIN" +"ADMIN", +"END_USER_MOBILE" ], "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." +"The Cloud Console admin \"Feature Control\" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated.", +"The end-user model selector view for the Gemini Enterprise mobile app. Returns only mobile-surfaced models, with the mobile default selected. Set explicitly by the mobile client." ], "location": "query", "type": "string" @@ -11520,16 +11524,18 @@ "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`).", +"description": "Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `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; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector.", "enum": [ "MODEL_INFO_VIEW_UNSPECIFIED", "END_USER_WEB", -"ADMIN" +"ADMIN", +"END_USER_MOBILE" ], "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." +"The Cloud Console admin \"Feature Control\" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated.", +"The end-user model selector view for the Gemini Enterprise mobile app. Returns only mobile-surfaced models, with the mobile default selected. Set explicitly by the mobile client." ], "location": "query", "type": "string" @@ -12265,163 +12271,6 @@ } }, "notebooks": { -"methods": { -"batchDelete": { -"description": "Batch deletes Notebooks.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks:batchDelete", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.notebooks.batchDelete", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}`.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+parent}/notebooks:batchDelete", -"request": { -"$ref": "GoogleCloudNotebooklmV1alphaBatchDeleteNotebooksRequest" -}, -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/discoveryengine.readwrite", -"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" -] -}, -"create": { -"description": "Creates a notebook.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.notebooks.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+parent}/notebooks", -"request": { -"$ref": "GoogleCloudNotebooklmV1alphaNotebook" -}, -"response": { -"$ref": "GoogleCloudNotebooklmV1alphaNotebook" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/discoveryengine.readwrite", -"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" -] -}, -"get": { -"description": "Gets a notebook.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.notebooks.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Full resource name of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+name}", -"response": { -"$ref": "GoogleCloudNotebooklmV1alphaNotebook" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/discoveryengine.readwrite", -"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" -] -}, -"listRecentlyViewed": { -"description": "Lists the notebooks ordered by last view time.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks:listRecentlyViewed", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.notebooks.listRecentlyViewed", -"parameterOrder": [ -"parent" -], -"parameters": { -"pageSize": { -"description": "Optional. Maximum number of Notebooks to return. If unspecified, defaults to \"500\". The maximum allowed value is \"500\". If this field is negative, will use the default value.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. The page token, provide this to retrieve the subsequent page.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}`.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+parent}/notebooks:listRecentlyViewed", -"response": { -"$ref": "GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/discoveryengine.readwrite", -"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" -] -}, -"share": { -"description": "Shares a notebook to other accounts.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}:share", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.notebooks.share", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Full resource name of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+name}:share", -"request": { -"$ref": "GoogleCloudNotebooklmV1alphaShareNotebookRequest" -}, -"response": { -"$ref": "GoogleCloudNotebooklmV1alphaShareNotebookResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/discoveryengine.readwrite", -"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" -] -} -}, "resources": { "audioOverviews": { "methods": { @@ -12483,98 +12332,6 @@ ] } } -}, -"sources": { -"methods": { -"batchCreate": { -"description": "Creates a list of Sources.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/sources:batchCreate", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.notebooks.sources.batchCreate", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The parent resource where the sources will be created. Format: projects/{project}/locations/{location}/notebooks/{notebook}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+parent}/sources:batchCreate", -"request": { -"$ref": "GoogleCloudNotebooklmV1alphaBatchCreateSourcesRequest" -}, -"response": { -"$ref": "GoogleCloudNotebooklmV1alphaBatchCreateSourcesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", -"https://www.googleapis.com/auth/discoveryengine.readwrite", -"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" -] -}, -"batchDelete": { -"description": "Deletes multiple sources", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/sources:batchDelete", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.notebooks.sources.batchDelete", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The parent resource where the sources will be deleted. Format: projects/{project}/locations/{location}/notebooks/{notebook}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+parent}/sources:batchDelete", -"request": { -"$ref": "GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest" -}, -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/discoveryengine.readwrite", -"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" -] -}, -"get": { -"description": "Gets a Source.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/sources/{sourcesId}", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.notebooks.sources.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name for source Format: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+/sources/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+name}", -"response": { -"$ref": "GoogleCloudNotebooklmV1alphaSource" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/discoveryengine.readwrite", -"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" -] -} -} } } }, @@ -13647,7 +13404,7 @@ } } }, -"revision": "20260831", +"revision": "20260908", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -14346,6 +14103,10 @@ }, "type": "array" }, +"dataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1DataProtectionPolicy", +"description": "Optional. Data protection policy to be used for sanitizing file uploads." +}, "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig", "description": "Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses." @@ -15262,6 +15023,10 @@ "readOnly": true, "type": "string" }, +"dataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1DataProtectionPolicy", +"description": "Optional. Specifies the data protection policy for the connector." +}, "dataSource": { "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" @@ -15672,6 +15437,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DataProtectionPolicy": { +"description": "Contains the data protection policy config for a DataStore or a connector.", +"id": "GoogleCloudDiscoveryengineV1DataProtectionPolicy", +"properties": { +"sensitiveDataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1DataProtectionPolicySensitiveDataProtectionPolicy", +"description": "Optional. Specifies the sensitive data protection policy for the connector source." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataProtectionPolicySensitiveDataProtectionPolicy": { +"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.", +"id": "GoogleCloudDiscoveryengineV1DataProtectionPolicySensitiveDataProtectionPolicy", +"properties": { +"policy": { +"description": "Optional. Specifies the resource name of the Sensitive Data Protection content policy.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DataStore": { "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStore", @@ -15738,6 +15525,10 @@ "readOnly": true, "type": "string" }, +"dataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1DataProtectionPolicy", +"description": "Optional. Specifies the data protection policy for the data store." +}, "defaultSchemaId": { "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, @@ -16577,6 +16368,10 @@ "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, +"sessionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1SessionConfig", +"description": "Optional. Non-empty default. Session config for the engine." +}, "solutionType": { "description": "Required. The solutions of the engine.", "enum": [ @@ -18183,6 +17978,43 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1SessionConfig": { +"description": "Configuration for the session.", +"id": "GoogleCloudDiscoveryengineV1SessionConfig", +"properties": { +"sessionManagementPolicy": { +"description": "Optional. Session management policy that defines who will manage the session.", +"enum": [ +"SESSION_MANAGEMENT_POLICY_UNSPECIFIED", +"NOT_MANAGED", +"VERTEX_AI_MANAGED" +], +"enumDescriptions": [ +"Default value.", +"The session will be managed by the customer.", +"Sessions multi-tenancy will be controlled by Google using 1P or 3P identity providers." +], +"type": "string" +}, +"sessionTtl": { +"$ref": "GoogleCloudDiscoveryengineV1SessionConfigSessionTtl", +"description": "Optional. The TTL for the session. If unset, the default value is 60 days." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1SessionConfigSessionTtl": { +"description": "Defines the TTL for sessions.", +"id": "GoogleCloudDiscoveryengineV1SessionConfigSessionTtl", +"properties": { +"days": { +"description": "Defines the number of days for session TTL.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata": { "description": "Metadata for DataConnectorService.SetUpDataConnector method.", "id": "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata", @@ -19699,6 +19531,24 @@ "description": "Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models.", "type": "string" }, +"thinkingLevel": { +"description": "Optional. Sent as Vertex `ThinkingConfig.thinking_level`.", +"enum": [ +"THINKING_LEVEL_UNSPECIFIED", +"MINIMAL", +"LOW", +"MEDIUM", +"HIGH" +], +"enumDescriptions": [ +"Unset. The model applies its own default, which is not the same level for every model.", +"Least thinking. Not offered by every model.", +"Vertex `LOW`.", +"Vertex `MEDIUM`.", +"Vertex `HIGH`." +], +"type": "string" +}, "weight": { "description": "Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT.", "format": "float", @@ -26226,6 +26076,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, +"sessionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSessionConfig", +"description": "Optional. Non-empty default. Session config for the engine." +}, "similarDocumentsConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", "description": "Additional config specs for a `similar-items` engine." @@ -33418,6 +33272,43 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaSessionConfig": { +"description": "Configuration for the session.", +"id": "GoogleCloudDiscoveryengineV1alphaSessionConfig", +"properties": { +"sessionManagementPolicy": { +"description": "Optional. Session management policy that defines who will manage the session.", +"enum": [ +"SESSION_MANAGEMENT_POLICY_UNSPECIFIED", +"NOT_MANAGED", +"VERTEX_AI_MANAGED" +], +"enumDescriptions": [ +"Default value.", +"The session will be managed by the customer.", +"Sessions multi-tenancy will be controlled by Google using 1P or 3P identity providers." +], +"type": "string" +}, +"sessionTtl": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSessionConfigSessionTtl", +"description": "Optional. The TTL for the session. If unset, the default value is 60 days." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSessionConfigSessionTtl": { +"description": "Defines the TTL for sessions.", +"id": "GoogleCloudDiscoveryengineV1alphaSessionConfigSessionTtl", +"properties": { +"days": { +"description": "Defines the number of days for session TTL.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSessionTurn": { "description": "Represents a turn, including a query from the user and a answer from service.", "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", @@ -35749,6 +35640,11 @@ false "readOnly": true, "type": "string" }, +"iconUrl": { +"description": "Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing.", +"readOnly": true, +"type": "string" +}, "isPreview": { "description": "Output only. Whether the model is currently in preview. Clients should surface this via a \"Preview\" badge in the selector UI.", "readOnly": true, @@ -36485,6 +36381,28 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDataProtectionPolicy": { +"description": "Contains the data protection policy config for a DataStore or a connector.", +"id": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicy", +"properties": { +"sensitiveDataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicySensitiveDataProtectionPolicy", +"description": "Optional. Specifies the sensitive data protection policy for the connector source." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataProtectionPolicySensitiveDataProtectionPolicy": { +"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.", +"id": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicySensitiveDataProtectionPolicy", +"properties": { +"policy": { +"description": "Optional. Specifies the resource name of the Sensitive Data Protection content policy.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDataStore": { "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1betaDataStore", @@ -36551,6 +36469,10 @@ false "readOnly": true, "type": "string" }, +"dataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicy", +"description": "Optional. Specifies the data protection policy for the data store." +}, "defaultSchemaId": { "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, @@ -37314,6 +37236,10 @@ false "$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, +"sessionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaSessionConfig", +"description": "Optional. Non-empty default. Session config for the engine." +}, "solutionType": { "description": "Required. The solutions of the engine.", "enum": [ @@ -39826,6 +39752,43 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaSessionConfig": { +"description": "Configuration for the session.", +"id": "GoogleCloudDiscoveryengineV1betaSessionConfig", +"properties": { +"sessionManagementPolicy": { +"description": "Optional. Session management policy that defines who will manage the session.", +"enum": [ +"SESSION_MANAGEMENT_POLICY_UNSPECIFIED", +"NOT_MANAGED", +"VERTEX_AI_MANAGED" +], +"enumDescriptions": [ +"Default value.", +"The session will be managed by the customer.", +"Sessions multi-tenancy will be controlled by Google using 1P or 3P identity providers." +], +"type": "string" +}, +"sessionTtl": { +"$ref": "GoogleCloudDiscoveryengineV1betaSessionConfigSessionTtl", +"description": "Optional. The TTL for the session. If unset, the default value is 60 days." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSessionConfigSessionTtl": { +"description": "Defines the TTL for sessions.", +"id": "GoogleCloudDiscoveryengineV1betaSessionConfigSessionTtl", +"properties": { +"days": { +"description": "Defines the number of days for session TTL.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata": { "description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata", @@ -40309,52 +40272,6 @@ false }, "type": "object" }, -"GoogleCloudNotebooklmV1alphaAccountAndRole": { -"description": "Account and role information.", -"id": "GoogleCloudNotebooklmV1alphaAccountAndRole", -"properties": { -"email": { -"description": "Required. The email address associated with the account.", -"type": "string" -}, -"role": { -"description": "Required. The role in the notebook.", -"enum": [ -"PROJECT_ROLE_UNKNOWN", -"PROJECT_ROLE_OWNER", -"PROJECT_ROLE_WRITER", -"PROJECT_ROLE_READER", -"PROJECT_ROLE_NOT_SHARED" -], -"enumDescriptions": [ -"Unknown role.", -"The user owns the project.", -"The user has writer permissions on the project.", -"The user has reader permissions on the project.", -"The user has no access to the project." -], -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaAgentspaceMetadata": { -"description": "Metadata about an agentspace source.", -"id": "GoogleCloudNotebooklmV1alphaAgentspaceMetadata", -"properties": { -"documentName": { -"description": "Output only. The full document name in Agentspace.", -"readOnly": true, -"type": "string" -}, -"documentTitle": { -"description": "Output only. The title of the document.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudNotebooklmV1alphaAudioOverview": { "description": "An audio overview of a notebook. This is a summary of the notebook in audio format.", "id": "GoogleCloudNotebooklmV1alphaAudioOverview", @@ -40433,73 +40350,6 @@ false }, "type": "object" }, -"GoogleCloudNotebooklmV1alphaBatchCreateSourcesRequest": { -"description": "Request for SourceService.BatchCreateSources method.", -"id": "GoogleCloudNotebooklmV1alphaBatchCreateSourcesRequest", -"properties": { -"userContents": { -"description": "Required. The UserContents to be uploaded.", -"items": { -"$ref": "GoogleCloudNotebooklmV1alphaUserContent" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaBatchCreateSourcesResponse": { -"description": "Response for SourceService.BatchCreateSources method.", -"id": "GoogleCloudNotebooklmV1alphaBatchCreateSourcesResponse", -"properties": { -"sources": { -"description": "The Sources.", -"items": { -"$ref": "GoogleCloudNotebooklmV1alphaSource" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaBatchDeleteNotebooksRequest": { -"description": "Request for NotebookService.BatchDeleteNotebooks method.", -"id": "GoogleCloudNotebooklmV1alphaBatchDeleteNotebooksRequest", -"properties": { -"names": { -"description": "Required. Full resource names of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest": { -"description": "Request for BatchDeleteSourcesRequest method.", -"id": "GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest", -"properties": { -"names": { -"description": "Required. Names of sources to be deleted. Format: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaCmekConfig": { -"description": "Customer-managed encryption configuration for Notebooks.", -"id": "GoogleCloudNotebooklmV1alphaCmekConfig", -"properties": { -"kmsKey": { -"description": "Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudNotebooklmV1alphaCreateAudioOverviewRequest": { "description": "Request for AudioOverviewService.CreateAudioOverview method.", "id": "GoogleCloudNotebooklmV1alphaCreateAudioOverviewRequest", @@ -40522,389 +40372,6 @@ false }, "type": "object" }, -"GoogleCloudNotebooklmV1alphaFailureReason": { -"description": "Failure reason containing details about why a source failed to ingest.", -"id": "GoogleCloudNotebooklmV1alphaFailureReason", -"properties": { -"audioTranscriptionError": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError", -"description": "An audio file transcription specific error." -}, -"domainBlocked": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked", -"description": "Error if the user tries to add a source from a blocked domain." -}, -"googleDriveError": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError", -"description": "A google drive specific error." -}, -"ingestionError": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonIngestionError", -"description": "Indicates an error occurred while ingesting the source." -}, -"mimeTypeBlocked": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonMimeTypeBlocked", -"description": "Indicates that the source MIME type is blocked." -}, -"paywallError": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonPaywallError", -"description": "Indicates that the source is paywalled and cannot be ingested." -}, -"policyCheckFailed": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonPolicyCheckFailed", -"description": "Indicates that the policy check failed." -}, -"sourceEmpty": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty", -"description": "Indicates that the source is empty." -}, -"sourceLimitExceeded": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded", -"description": "Error if the user tries to update beyond their limits." -}, -"sourceTooLong": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong", -"description": "Indicates source word count exceeded the user's limit." -}, -"sourceUnreachable": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable", -"description": "Indicates that the source is unreachable." -}, -"unknown": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonUnknown", -"description": "Indicates an unknown error occurred." -}, -"uploadError": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonUploadError", -"description": "Indicates an error occurred while uploading the source." -}, -"youtubeError": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError", -"description": "A youtube specific error." -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError": { -"description": "An audio file transcription specific error.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError", -"properties": { -"languageDetectionFailed": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed", -"description": "Could not detect language of the file (it may not be speech)." -}, -"noAudioDetected": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected", -"description": "No audio was detected in the input file (it may have been a video)." -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed": { -"description": "Could not detect language of the file (it may not be speech).", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed", -"properties": {}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected": { -"description": "No audio was detected in the input file.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected", -"properties": {}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked": { -"description": "Error to indicate that the source was removed because the domain was blocked.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked", -"properties": {}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError": { -"description": "A google drive specific error.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError", -"properties": { -"downloadPrevented": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented", -"description": "The user was prevented from downloading the file." -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented": { -"description": "The user was prevented from downloading the file.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented", -"properties": {}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonIngestionError": { -"description": "Indicates an error occurred while ingesting the source.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonIngestionError", -"properties": {}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonMimeTypeBlocked": { -"description": "Indicates that the source MIME type is blocked.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonMimeTypeBlocked", -"properties": {}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonPaywallError": { -"description": "Indicates that the source is paywalled and cannot be ingested.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonPaywallError", -"properties": {}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonPolicyCheckFailed": { -"description": "Indicates that the policy check failed.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonPolicyCheckFailed", -"properties": {}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty": { -"description": "Indicates that the source is empty.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty", -"properties": {}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded": { -"description": "Indicates that the user does not have space for this source.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded", -"properties": {}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong": { -"description": "Indicates source word count exceeded the user's limit.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong", -"properties": { -"wordCount": { -"description": "The number of words in the source.", -"format": "int32", -"type": "integer" -}, -"wordLimit": { -"description": "The word count limit for the current user at the time of the upload.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable": { -"description": "Indicates that the source is unreachable. This is primarily used for sources that are added via URL.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable", -"properties": { -"errorDetails": { -"description": "Describes why the source is unreachable.", -"enum": [ -"ERROR_REASON_UNSPECIFIED", -"ERROR_REASON_INVALID_URL", -"ERROR_REASON_NOT_ACCESSIBLE", -"ERROR_REASON_NOT_REACHABLE", -"ERROR_REASON_URL_NOT_FOUND", -"ERROR_REASON_TRANSIENT_ERROR", -"ERROR_REASON_FETCH_FAILED", -"ERROR_REASON_NOT_SUPPORTED" -], -"enumDescriptions": [ -"Default", -"The source URL is invalid.", -"The source URL is not accessible.", -"The source URL is not reachable.", -"The source URL returned 404.", -"The source URL not reachable due to a transient network error or host timeout etc.", -"The source URL could not be fetched due to an internal error.", -"The URL is not yet supported. Examples include: the fetched content exceeds the trawler fetch max size, the fetched content is a type we do not yet support, etc." -], -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonUnknown": { -"description": "Indicates an unknown error occurred.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonUnknown", -"properties": {}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonUploadError": { -"description": "Indicates an error occurred while uploading the source.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonUploadError", -"properties": {}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError": { -"description": "A youtube specific error.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError", -"properties": { -"videoDeleted": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted", -"description": "Error to indicate that the source was removed because the video was deleted." -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted": { -"description": "Error to indicate that the source was removed because the video was deleted.", -"id": "GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted", -"properties": {}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata": { -"description": "Metadata about a google doc source.", -"id": "GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata", -"properties": { -"documentId": { -"description": "Output only. The document id of the google doc.", -"readOnly": true, -"type": "string" -}, -"revisionId": { -"description": "Output only. Revision id for the doc.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse": { -"description": "Response for NotebookService.ListRecentlyViewedNotebooks method.", -"id": "GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse", -"properties": { -"nextPageToken": { -"description": "The page token, provide this to retrieve the subsequent page.", -"type": "string" -}, -"notebooks": { -"description": "The list of recently viewed notebooks.", -"items": { -"$ref": "GoogleCloudNotebooklmV1alphaNotebook" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaNotebook": { -"description": "Notebook is a resource where users can store their content (as sources) and interacts with the content.", -"id": "GoogleCloudNotebooklmV1alphaNotebook", -"properties": { -"cmekConfig": { -"$ref": "GoogleCloudNotebooklmV1alphaCmekConfig", -"description": "Output only. CMEK-related information for the Notebook.", -"readOnly": true -}, -"emoji": { -"description": "Output only. The emoji of the notebook.", -"readOnly": true, -"type": "string" -}, -"metadata": { -"$ref": "GoogleCloudNotebooklmV1alphaNotebookMetadata", -"description": "Output only. The metadata of the notebook.", -"readOnly": true -}, -"name": { -"description": "Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.", -"type": "string" -}, -"notebookId": { -"description": "Output only. Notebook id, which is the last segment of the notebook's resource name.", -"readOnly": true, -"type": "string" -}, -"sources": { -"description": "Output only. List of sources in the notebook. This is an output only field.", -"items": { -"$ref": "GoogleCloudNotebooklmV1alphaSource" -}, -"readOnly": true, -"type": "array" -}, -"title": { -"description": "Optional. The title of the notebook.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaNotebookMetadata": { -"description": "Metadata for a notebook.", -"id": "GoogleCloudNotebooklmV1alphaNotebookMetadata", -"properties": { -"createTime": { -"description": "The time at which this project was created.", -"format": "google-datetime", -"type": "string" -}, -"isShareable": { -"description": "True if the project is shareable.", -"type": "boolean" -}, -"isShared": { -"description": "True if this project is currently shared with other people, false otherwise.", -"type": "boolean" -}, -"lastViewed": { -"description": "A timestamp indicating the time that the current in session user has last viewed the project.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaShareNotebookRequest": { -"description": "Request for NotebookService.ShareNotebook method.", -"id": "GoogleCloudNotebooklmV1alphaShareNotebookRequest", -"properties": { -"accountAndRoles": { -"description": "Required. The list of accounts and roles to share the notebook with.", -"items": { -"$ref": "GoogleCloudNotebooklmV1alphaAccountAndRole" -}, -"type": "array" -}, -"notifyViaEmail": { -"description": "Required. Whether to notify the shared users via email.", -"type": "boolean" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaShareNotebookResponse": { -"description": "Response for NotebookService.ShareNotebook method.", -"id": "GoogleCloudNotebooklmV1alphaShareNotebookResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaSource": { -"description": "Source represents a single source of content.", -"id": "GoogleCloudNotebooklmV1alphaSource", -"properties": { -"metadata": { -"$ref": "GoogleCloudNotebooklmV1alphaSourceMetadata", -"description": "Output only. Metadata about the source.", -"readOnly": true -}, -"name": { -"description": "Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", -"type": "string" -}, -"settings": { -"$ref": "GoogleCloudNotebooklmV1alphaSourceSettings", -"description": "Output only. Status of the source, and any failure reasons.", -"readOnly": true -}, -"sourceId": { -"$ref": "GoogleCloudNotebooklmV1alphaSourceId", -"description": "Optional. Output only. Source id, which is the last segment of the source's resource name.", -"readOnly": true -}, -"title": { -"description": "Optional. Title of the source.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudNotebooklmV1alphaSourceId": { "description": "SourceId is the last segment of the source's resource name.", "id": "GoogleCloudNotebooklmV1alphaSourceId", @@ -40916,194 +40383,6 @@ false }, "type": "object" }, -"GoogleCloudNotebooklmV1alphaSourceMetadata": { -"description": "Represents the metadata of a source and some additional information.", -"id": "GoogleCloudNotebooklmV1alphaSourceMetadata", -"properties": { -"agentspaceMetadata": { -"$ref": "GoogleCloudNotebooklmV1alphaAgentspaceMetadata", -"description": "Metadata for an agentspace source." -}, -"googleDocsMetadata": { -"$ref": "GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata", -"description": "Metadata for a google doc source." -}, -"sourceAddedTimestamp": { -"description": "The timestamp the source was added.", -"format": "google-datetime", -"type": "string" -}, -"tokenCount": { -"description": "The number of tokens in the source.", -"format": "int32", -"type": "integer" -}, -"wordCount": { -"description": "The word count of the source.", -"format": "int32", -"type": "integer" -}, -"youtubeMetadata": { -"$ref": "GoogleCloudNotebooklmV1alphaYoutubeMetadata", -"description": "Metadata for a youtube video source." -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaSourceSettings": { -"description": "Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request).", -"id": "GoogleCloudNotebooklmV1alphaSourceSettings", -"properties": { -"failureReason": { -"$ref": "GoogleCloudNotebooklmV1alphaFailureReason", -"description": "Failure reason containing details about why a source failed to ingest." -}, -"status": { -"description": "Status of the source.", -"enum": [ -"SOURCE_STATUS_UNSPECIFIED", -"SOURCE_STATUS_PENDING", -"SOURCE_STATUS_COMPLETE", -"SOURCE_STATUS_ERROR", -"SOURCE_STATUS_PENDING_DELETION", -"SOURCE_STATUS_TENTATIVE" -], -"enumDescriptions": [ -"Unspecified status.", -"The source is pending addition.", -"Source addition is complete and successful.", -"Source addition has permanently failed.", -"The source is pending deletion.", -"The user is attempting to add a source, but we have not yet uploaded it or checked user limits. Does not count towards the user's source limit." -], -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaUserContent": { -"description": "The \"Content\" messages refer to data the user wants to upload.", -"id": "GoogleCloudNotebooklmV1alphaUserContent", -"properties": { -"agentspaceContent": { -"$ref": "GoogleCloudNotebooklmV1alphaUserContentAgentspaceContent", -"description": "Agentspace content uploaded as source." -}, -"googleDriveContent": { -"$ref": "GoogleCloudNotebooklmV1alphaUserContentGoogleDriveContent", -"description": "The content from Google Drive." -}, -"textContent": { -"$ref": "GoogleCloudNotebooklmV1alphaUserContentTextContent", -"description": "The text content uploaded as source." -}, -"videoContent": { -"$ref": "GoogleCloudNotebooklmV1alphaUserContentVideoContent", -"description": "The video content uploaded as source." -}, -"webContent": { -"$ref": "GoogleCloudNotebooklmV1alphaUserContentWebContent", -"description": "The web content uploaded as source." -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaUserContentAgentspaceContent": { -"description": "Agentspace content uploaded as source.", -"id": "GoogleCloudNotebooklmV1alphaUserContentAgentspaceContent", -"properties": { -"documentName": { -"description": "Optional. The full resource name of the Agentspace document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.", -"type": "string" -}, -"engineName": { -"description": "Optional. Engine to verify the permission of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`.", -"type": "string" -}, -"ideaforgeIdeaName": { -"description": "Optional. Resource name of the idea forge instance. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/ideaForgeInstances/{instance}`", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaUserContentGoogleDriveContent": { -"description": "The content from Google Drive.", -"id": "GoogleCloudNotebooklmV1alphaUserContentGoogleDriveContent", -"properties": { -"documentId": { -"description": "The document id of the selected document.", -"type": "string" -}, -"mimeType": { -"description": "The mime type of the selected document. This can be used to differentiate type of content selected in the drive picker. Use application/vnd.google-apps.document for Google Docs or application/vnd.google-apps.presentation for Google Slides.", -"type": "string" -}, -"sourceName": { -"description": "The name to be displayed for the source.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaUserContentTextContent": { -"description": "The text content uploaded as source.", -"id": "GoogleCloudNotebooklmV1alphaUserContentTextContent", -"properties": { -"content": { -"description": "The name to be displayed for the source.", -"type": "string" -}, -"sourceName": { -"description": "The display name of the text source.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaUserContentVideoContent": { -"description": "Video content uploaded as source.", -"id": "GoogleCloudNotebooklmV1alphaUserContentVideoContent", -"properties": { -"youtubeUrl": { -"description": "The youtube url of the video content.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaUserContentWebContent": { -"description": "The web content uploaded as source.", -"id": "GoogleCloudNotebooklmV1alphaUserContentWebContent", -"properties": { -"sourceName": { -"description": "The name to be displayed for the source.", -"type": "string" -}, -"url": { -"description": "If URL is supplied, will fetch the webpage in the backend.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudNotebooklmV1alphaYoutubeMetadata": { -"description": "Metadata about a youtube video source.", -"id": "GoogleCloudNotebooklmV1alphaYoutubeMetadata", -"properties": { -"channelName": { -"description": "Output only. The channel name of the youtube video.", -"readOnly": true, -"type": "string" -}, -"videoId": { -"description": "Output only. The id of the youtube video.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "GoogleIamV1Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "GoogleIamV1Binding", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 88e4a7ef5f..634e5cdd6e 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -9680,7 +9680,7 @@ } } }, -"revision": "20260831", +"revision": "20260908", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -10379,6 +10379,10 @@ }, "type": "array" }, +"dataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1DataProtectionPolicy", +"description": "Optional. Data protection policy to be used for sanitizing file uploads." +}, "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig", "description": "Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses." @@ -11295,6 +11299,10 @@ "readOnly": true, "type": "string" }, +"dataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1DataProtectionPolicy", +"description": "Optional. Specifies the data protection policy for the connector." +}, "dataSource": { "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" @@ -11705,6 +11713,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DataProtectionPolicy": { +"description": "Contains the data protection policy config for a DataStore or a connector.", +"id": "GoogleCloudDiscoveryengineV1DataProtectionPolicy", +"properties": { +"sensitiveDataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1DataProtectionPolicySensitiveDataProtectionPolicy", +"description": "Optional. Specifies the sensitive data protection policy for the connector source." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataProtectionPolicySensitiveDataProtectionPolicy": { +"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.", +"id": "GoogleCloudDiscoveryengineV1DataProtectionPolicySensitiveDataProtectionPolicy", +"properties": { +"policy": { +"description": "Optional. Specifies the resource name of the Sensitive Data Protection content policy.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DataStore": { "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStore", @@ -11771,6 +11801,10 @@ "readOnly": true, "type": "string" }, +"dataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1DataProtectionPolicy", +"description": "Optional. Specifies the data protection policy for the data store." +}, "defaultSchemaId": { "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, @@ -12610,6 +12644,10 @@ "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, +"sessionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1SessionConfig", +"description": "Optional. Non-empty default. Session config for the engine." +}, "solutionType": { "description": "Required. The solutions of the engine.", "enum": [ @@ -14216,6 +14254,43 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1SessionConfig": { +"description": "Configuration for the session.", +"id": "GoogleCloudDiscoveryengineV1SessionConfig", +"properties": { +"sessionManagementPolicy": { +"description": "Optional. Session management policy that defines who will manage the session.", +"enum": [ +"SESSION_MANAGEMENT_POLICY_UNSPECIFIED", +"NOT_MANAGED", +"VERTEX_AI_MANAGED" +], +"enumDescriptions": [ +"Default value.", +"The session will be managed by the customer.", +"Sessions multi-tenancy will be controlled by Google using 1P or 3P identity providers." +], +"type": "string" +}, +"sessionTtl": { +"$ref": "GoogleCloudDiscoveryengineV1SessionConfigSessionTtl", +"description": "Optional. The TTL for the session. If unset, the default value is 60 days." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1SessionConfigSessionTtl": { +"description": "Defines the TTL for sessions.", +"id": "GoogleCloudDiscoveryengineV1SessionConfigSessionTtl", +"properties": { +"days": { +"description": "Defines the number of days for session TTL.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata": { "description": "Metadata for DataConnectorService.SetUpDataConnector method.", "id": "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata", @@ -15084,6 +15159,24 @@ "description": "Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models.", "type": "string" }, +"thinkingLevel": { +"description": "Optional. Sent as Vertex `ThinkingConfig.thinking_level`.", +"enum": [ +"THINKING_LEVEL_UNSPECIFIED", +"MINIMAL", +"LOW", +"MEDIUM", +"HIGH" +], +"enumDescriptions": [ +"Unset. The model applies its own default, which is not the same level for every model.", +"Least thinking. Not offered by every model.", +"Vertex `LOW`.", +"Vertex `MEDIUM`.", +"Vertex `HIGH`." +], +"type": "string" +}, "weight": { "description": "Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT.", "format": "float", @@ -18882,6 +18975,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, +"sessionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSessionConfig", +"description": "Optional. Non-empty default. Session config for the engine." +}, "similarDocumentsConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", "description": "Additional config specs for a `similar-items` engine." @@ -22406,6 +22503,43 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaSessionConfig": { +"description": "Configuration for the session.", +"id": "GoogleCloudDiscoveryengineV1alphaSessionConfig", +"properties": { +"sessionManagementPolicy": { +"description": "Optional. Session management policy that defines who will manage the session.", +"enum": [ +"SESSION_MANAGEMENT_POLICY_UNSPECIFIED", +"NOT_MANAGED", +"VERTEX_AI_MANAGED" +], +"enumDescriptions": [ +"Default value.", +"The session will be managed by the customer.", +"Sessions multi-tenancy will be controlled by Google using 1P or 3P identity providers." +], +"type": "string" +}, +"sessionTtl": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSessionConfigSessionTtl", +"description": "Optional. The TTL for the session. If unset, the default value is 60 days." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSessionConfigSessionTtl": { +"description": "Defines the TTL for sessions.", +"id": "GoogleCloudDiscoveryengineV1alphaSessionConfigSessionTtl", +"properties": { +"days": { +"description": "Defines the number of days for session TTL.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSessionTurn": { "description": "Represents a turn, including a query from the user and a answer from service.", "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", @@ -25083,6 +25217,10 @@ false }, "type": "array" }, +"dataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicy", +"description": "Optional. Data protection policy to be used for sanitizing file uploads." +}, "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicyModelArmorConfig", "description": "Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses." @@ -26990,6 +27128,28 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDataProtectionPolicy": { +"description": "Contains the data protection policy config for a DataStore or a connector.", +"id": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicy", +"properties": { +"sensitiveDataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicySensitiveDataProtectionPolicy", +"description": "Optional. Specifies the sensitive data protection policy for the connector source." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDataProtectionPolicySensitiveDataProtectionPolicy": { +"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.", +"id": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicySensitiveDataProtectionPolicy", +"properties": { +"policy": { +"description": "Optional. Specifies the resource name of the Sensitive Data Protection content policy.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDataStore": { "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1betaDataStore", @@ -27056,6 +27216,10 @@ false "readOnly": true, "type": "string" }, +"dataProtectionPolicy": { +"$ref": "GoogleCloudDiscoveryengineV1betaDataProtectionPolicy", +"description": "Optional. Specifies the data protection policy for the data store." +}, "defaultSchemaId": { "description": "Output only. The id of the default Schema associated to this data store.", "readOnly": true, @@ -28072,6 +28236,10 @@ false "$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, +"sessionConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaSessionConfig", +"description": "Optional. Non-empty default. Session config for the engine." +}, "solutionType": { "description": "Required. The solutions of the engine.", "enum": [ @@ -33444,6 +33612,43 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaSessionConfig": { +"description": "Configuration for the session.", +"id": "GoogleCloudDiscoveryengineV1betaSessionConfig", +"properties": { +"sessionManagementPolicy": { +"description": "Optional. Session management policy that defines who will manage the session.", +"enum": [ +"SESSION_MANAGEMENT_POLICY_UNSPECIFIED", +"NOT_MANAGED", +"VERTEX_AI_MANAGED" +], +"enumDescriptions": [ +"Default value.", +"The session will be managed by the customer.", +"Sessions multi-tenancy will be controlled by Google using 1P or 3P identity providers." +], +"type": "string" +}, +"sessionTtl": { +"$ref": "GoogleCloudDiscoveryengineV1betaSessionConfigSessionTtl", +"description": "Optional. The TTL for the session. If unset, the default value is 60 days." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSessionConfigSessionTtl": { +"description": "Defines the TTL for sessions.", +"id": "GoogleCloudDiscoveryengineV1betaSessionConfigSessionTtl", +"properties": { +"days": { +"description": "Defines the number of days for session TTL.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaSessionTurn": { "description": "Represents a turn, including a query from the user and a answer from service.", "id": "GoogleCloudDiscoveryengineV1betaSessionTurn", From 252d5056a5011420f2be23456cc6658ab7fb6409 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:29 +0000 Subject: [PATCH 17/30] feat(ftp): update the api #### ftp:v1 The following keys were added: - schemas.Server.properties.satisfiesPzi (Total Keys: 2) - schemas.Server.properties.satisfiesPzs (Total Keys: 2) #### ftp:v1alpha The following keys were added: - schemas.Server.properties.satisfiesPzi (Total Keys: 2) - schemas.Server.properties.satisfiesPzs (Total Keys: 2) --- docs/dyn/ftp_v1.projects.locations.servers.html | 8 ++++++++ docs/dyn/ftp_v1alpha.projects.locations.servers.html | 8 ++++++++ .../discovery_cache/documents/ftp.v1.json | 12 +++++++++++- .../discovery_cache/documents/ftp.v1alpha.json | 12 +++++++++++- 4 files changed, 38 insertions(+), 2 deletions(-) diff --git a/docs/dyn/ftp_v1.projects.locations.servers.html b/docs/dyn/ftp_v1.projects.locations.servers.html index 6b9f992bb1..cd84b4c00e 100644 --- a/docs/dyn/ftp_v1.projects.locations.servers.html +++ b/docs/dyn/ftp_v1.projects.locations.servers.html @@ -160,6 +160,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. name of resource + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAgent": "A String", # Output only. Service agent used to access the customer bucket. "state": "A String", # Output only. The state of the server. "updateTime": "A String", # Output only. [Output only] Update time stamp @@ -289,6 +291,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. name of resource + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAgent": "A String", # Output only. Service agent used to access the customer bucket. "state": "A String", # Output only. The state of the server. "updateTime": "A String", # Output only. [Output only] Update time stamp @@ -360,6 +364,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. name of resource + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAgent": "A String", # Output only. Service agent used to access the customer bucket. "state": "A String", # Output only. The state of the server. "updateTime": "A String", # Output only. [Output only] Update time stamp @@ -433,6 +439,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. name of resource + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAgent": "A String", # Output only. Service agent used to access the customer bucket. "state": "A String", # Output only. The state of the server. "updateTime": "A String", # Output only. [Output only] Update time stamp diff --git a/docs/dyn/ftp_v1alpha.projects.locations.servers.html b/docs/dyn/ftp_v1alpha.projects.locations.servers.html index 31693ab3b9..d250a81d1c 100644 --- a/docs/dyn/ftp_v1alpha.projects.locations.servers.html +++ b/docs/dyn/ftp_v1alpha.projects.locations.servers.html @@ -160,6 +160,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. name of resource + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAgent": "A String", # Output only. Service agent used to access the customer bucket. "state": "A String", # Output only. The state of the server. "updateTime": "A String", # Output only. [Output only] Update time stamp @@ -289,6 +291,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. name of resource + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAgent": "A String", # Output only. Service agent used to access the customer bucket. "state": "A String", # Output only. The state of the server. "updateTime": "A String", # Output only. [Output only] Update time stamp @@ -360,6 +364,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. name of resource + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAgent": "A String", # Output only. Service agent used to access the customer bucket. "state": "A String", # Output only. The state of the server. "updateTime": "A String", # Output only. [Output only] Update time stamp @@ -433,6 +439,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. name of resource + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAgent": "A String", # Output only. Service agent used to access the customer bucket. "state": "A String", # Output only. The state of the server. "updateTime": "A String", # Output only. [Output only] Update time stamp diff --git a/googleapiclient/discovery_cache/documents/ftp.v1.json b/googleapiclient/discovery_cache/documents/ftp.v1.json index ee30d57067..208d7f926f 100644 --- a/googleapiclient/discovery_cache/documents/ftp.v1.json +++ b/googleapiclient/discovery_cache/documents/ftp.v1.json @@ -788,7 +788,7 @@ } } }, -"revision": "20260815", +"revision": "20260909", "rootUrl": "https://ftp.googleapis.com/", "schemas": { "AllowedConsumer": { @@ -1163,6 +1163,16 @@ "description": "Identifier. name of resource", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "serviceAgent": { "description": "Output only. Service agent used to access the customer bucket.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/ftp.v1alpha.json b/googleapiclient/discovery_cache/documents/ftp.v1alpha.json index a179f5b19e..f14acc4964 100644 --- a/googleapiclient/discovery_cache/documents/ftp.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/ftp.v1alpha.json @@ -788,7 +788,7 @@ } } }, -"revision": "20260815", +"revision": "20260909", "rootUrl": "https://ftp.googleapis.com/", "schemas": { "AllowedConsumer": { @@ -1163,6 +1163,16 @@ "description": "Identifier. name of resource", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "serviceAgent": { "description": "Output only. Service agent used to access the customer bucket.", "readOnly": true, From 5e78bece7eee2a86a0f4dff8bd5b6cba43010ae2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:29 +0000 Subject: [PATCH 18/30] feat(games): update the api #### games:v1 The following keys were deleted: - schemas.PropertyValue.properties.timestampValue (Total Keys: 2) --- docs/dyn/games_v1.gameStats.html | 1 - googleapiclient/discovery_cache/documents/games.v1.json | 7 +------ 2 files changed, 1 insertion(+), 7 deletions(-) diff --git a/docs/dyn/games_v1.gameStats.html b/docs/dyn/games_v1.gameStats.html index cd0b144386..a2c22678cf 100644 --- a/docs/dyn/games_v1.gameStats.html +++ b/docs/dyn/games_v1.gameStats.html @@ -103,7 +103,6 @@

Method Details

"durationValue": "A String", # A duration value. "intValue": "A String", # An integer value. "stringValue": "A String", # A string value. - "timestampValue": "A String", # A timestamp value. }, }, "eventTime": "A String", # Required. The time from the client when this specific event was performed. diff --git a/googleapiclient/discovery_cache/documents/games.v1.json b/googleapiclient/discovery_cache/documents/games.v1.json index 935211b343..ca5e0ffe06 100644 --- a/googleapiclient/discovery_cache/documents/games.v1.json +++ b/googleapiclient/discovery_cache/documents/games.v1.json @@ -1501,7 +1501,7 @@ false } } }, -"revision": "20260813", +"revision": "20260907", "rootUrl": "https://games.googleapis.com/", "schemas": { "AchievementDefinition": { @@ -3410,11 +3410,6 @@ false "stringValue": { "description": "A string value.", "type": "string" -}, -"timestampValue": { -"description": "A timestamp value.", -"format": "google-datetime", -"type": "string" } }, "type": "object" From 93e36fc157eeddcf2e89380ea0900c6006ecbad4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:30 +0000 Subject: [PATCH 19/30] feat(health): update the api #### health:v4 The following keys were added: - schemas.GoogleDevicesandservicesHealthV4betaDataType (Total Keys: 3) - schemas.GoogleDevicesandservicesHealthV4betaUser (Total Keys: 3) - schemas.GoogleDevicesandservicesHealthV4betaWebhookNotificationCloudLog (Total Keys: 3) - schemas.HeartRateVariability.properties.metadata.$ref (Total Keys: 1) - schemas.HeartRateVariabilityMetadata (Total Keys: 6) --- .../health_v4.users.dataTypes.dataPoints.html | 20 + docs/dyn/health_v4.users.html | 24 +- docs/dyn/health_v4beta.html | 121 + docs/dyn/health_v4beta.projects.html | 91 + .../health_v4beta.projects.subscribers.html | 313 + ...ta.projects.subscribers.subscriptions.html | 233 + docs/dyn/health_v4beta.shl.html | 96 + docs/dyn/health_v4beta.shl.m.html | 123 + docs/dyn/health_v4beta.shl.r.html | 115 + ...lth_v4beta.users.dataTypes.dataPoints.html | 7559 +++++++++++++++++ docs/dyn/health_v4beta.users.dataTypes.html | 91 + docs/dyn/health_v4beta.users.html | 321 + .../health_v4beta.users.pairedDevices.html | 172 + .../discovery_cache/documents/health.v4.json | 64 +- .../documents/health.v4beta.json | 6625 +++++++++++++++ 15 files changed, 15951 insertions(+), 17 deletions(-) create mode 100644 docs/dyn/health_v4beta.html create mode 100644 docs/dyn/health_v4beta.projects.html create mode 100644 docs/dyn/health_v4beta.projects.subscribers.html create mode 100644 docs/dyn/health_v4beta.projects.subscribers.subscriptions.html create mode 100644 docs/dyn/health_v4beta.shl.html create mode 100644 docs/dyn/health_v4beta.shl.m.html create mode 100644 docs/dyn/health_v4beta.shl.r.html create mode 100644 docs/dyn/health_v4beta.users.dataTypes.dataPoints.html create mode 100644 docs/dyn/health_v4beta.users.dataTypes.html create mode 100644 docs/dyn/health_v4beta.users.html create mode 100644 docs/dyn/health_v4beta.users.pairedDevices.html create mode 100644 googleapiclient/discovery_cache/documents/health.v4beta.json diff --git a/docs/dyn/health_v4.users.dataTypes.dataPoints.html b/docs/dyn/health_v4.users.dataTypes.dataPoints.html index d95b30120b..0ecc9adafe 100644 --- a/docs/dyn/health_v4.users.dataTypes.dataPoints.html +++ b/docs/dyn/health_v4.users.dataTypes.dataPoints.html @@ -900,6 +900,10 @@

Method Details

}, }, "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection. + "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces. + "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz). + "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz). + }, "rootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time of the heart rate variability measurement. "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. @@ -2614,6 +2618,10 @@

Method Details

}, }, "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection. + "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces. + "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz). + "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz). + }, "rootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time of the heart rate variability measurement. "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. @@ -4055,6 +4063,10 @@

Method Details

}, }, "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection. + "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces. + "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz). + "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz). + }, "rootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time of the heart rate variability measurement. "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. @@ -5503,6 +5515,10 @@

Method Details

}, }, "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection. + "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces. + "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz). + "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz). + }, "rootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time of the heart rate variability measurement. "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. @@ -6850,6 +6866,10 @@

Method Details

}, }, "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Data for points in the `heart-rate-variability` sample data type collection. + "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces. + "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz). + "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz). + }, "rootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time of the heart rate variability measurement. "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. diff --git a/docs/dyn/health_v4.users.html b/docs/dyn/health_v4.users.html index deb3e06468..eb74ef474e 100644 --- a/docs/dyn/health_v4.users.html +++ b/docs/dyn/health_v4.users.html @@ -170,16 +170,16 @@

Method Details

{ # Profile details. "age": 42, # Optional. The age in years based on the user's birth date. Updates to this field are currently not supported. - "autoRunningStrideLengthMm": 42, # Output only. The automatically calculated running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness` - "autoWalkingStrideLengthMm": 42, # Output only. The automatically calculated walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness` + "autoRunningStrideLengthMm": 42, # Output only. The automatically calculated running stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` + "autoWalkingStrideLengthMm": 42, # Output only. The automatically calculated walking stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` "membershipStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date the user created their account. Updates to this field are currently not supported. "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. }, "name": "A String", # Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user. - "userConfiguredRunningStrideLengthMm": 42, # Optional. The user's user configured running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness` - "userConfiguredWalkingStrideLengthMm": 42, # Optional. The user's user configured walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness` + "userConfiguredRunningStrideLengthMm": 42, # Optional. The user's user configured running stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` + "userConfiguredWalkingStrideLengthMm": 42, # Optional. The user's user configured walking stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` }
@@ -227,16 +227,16 @@

Method Details

{ # Profile details. "age": 42, # Optional. The age in years based on the user's birth date. Updates to this field are currently not supported. - "autoRunningStrideLengthMm": 42, # Output only. The automatically calculated running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness` - "autoWalkingStrideLengthMm": 42, # Output only. The automatically calculated walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness` + "autoRunningStrideLengthMm": 42, # Output only. The automatically calculated running stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` + "autoWalkingStrideLengthMm": 42, # Output only. The automatically calculated walking stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` "membershipStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date the user created their account. Updates to this field are currently not supported. "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. }, "name": "A String", # Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user. - "userConfiguredRunningStrideLengthMm": 42, # Optional. The user's user configured running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness` - "userConfiguredWalkingStrideLengthMm": 42, # Optional. The user's user configured walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness` + "userConfiguredRunningStrideLengthMm": 42, # Optional. The user's user configured running stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` + "userConfiguredWalkingStrideLengthMm": 42, # Optional. The user's user configured walking stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` } updateMask: string, Optional. The list of fields to be updated. @@ -250,16 +250,16 @@

Method Details

{ # Profile details. "age": 42, # Optional. The age in years based on the user's birth date. Updates to this field are currently not supported. - "autoRunningStrideLengthMm": 42, # Output only. The automatically calculated running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness` - "autoWalkingStrideLengthMm": 42, # Output only. The automatically calculated walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness` + "autoRunningStrideLengthMm": 42, # Output only. The automatically calculated running stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` + "autoWalkingStrideLengthMm": 42, # Output only. The automatically calculated walking stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` "membershipStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date the user created their account. Updates to this field are currently not supported. "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. }, "name": "A String", # Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user. - "userConfiguredRunningStrideLengthMm": 42, # Optional. The user's user configured running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness` - "userConfiguredWalkingStrideLengthMm": 42, # Optional. The user's user configured walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness` + "userConfiguredRunningStrideLengthMm": 42, # Optional. The user's user configured running stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` + "userConfiguredWalkingStrideLengthMm": 42, # Optional. The user's user configured walking stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` }
diff --git a/docs/dyn/health_v4beta.html b/docs/dyn/health_v4beta.html new file mode 100644 index 0000000000..ed55503d1e --- /dev/null +++ b/docs/dyn/health_v4beta.html @@ -0,0 +1,121 @@ + + + +

Google Health API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ shl() +

+

Returns the shl Resource.

+ +

+ users() +

+

Returns the users Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request(callback=None)

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request(callback=None) +
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/health_v4beta.projects.html b/docs/dyn/health_v4beta.projects.html new file mode 100644 index 0000000000..3f63542c37 --- /dev/null +++ b/docs/dyn/health_v4beta.projects.html @@ -0,0 +1,91 @@ + + + +

Google Health API . projects

+

Instance Methods

+

+ subscribers() +

+

Returns the subscribers Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/health_v4beta.projects.subscribers.html b/docs/dyn/health_v4beta.projects.subscribers.html new file mode 100644 index 0000000000..4058b3431f --- /dev/null +++ b/docs/dyn/health_v4beta.projects.subscribers.html @@ -0,0 +1,313 @@ + + + +

Google Health API . projects . subscribers

+

Instance Methods

+

+ subscriptions() +

+

Returns the subscriptions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Registers a new subscriber endpoint to receive notifications. A subscriber represents an application or service that wishes to receive data change notifications for users who have granted consent. **Endpoint Verification:** For a subscriber to be successfully created, the provided `endpoint_uri` must be a valid HTTPS endpoint and must pass an automated verification check. The backend will send two HTTP POST requests to the `endpoint_uri`: 1. **Verification with Authorization:** * **Headers:** Includes `Content-Type: application/json` and `Authorization` (with the exact value from `CreateSubscriberPayload.endpoint_authorization.secret`). * **Body:** `{"type": "verification"}` * **Expected Response:** HTTP `201 Created`. 2. **Verification without Authorization:** * **Headers:** Includes `Content-Type: application/json`. The `Authorization` header is OMITTED. * **Body:** `{"type": "verification"}` * **Expected Response:** HTTP `401 Unauthorized` or `403 Forbidden`. Both tests must pass for the subscriber creation to succeed. If verification fails, the operation will not be completed and an error will be returned. This process ensures the endpoint is reachable and correctly validates the `Authorization` header.

+

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

+

Deletes a subscriber registration. This will stop all notifications to the subscriber's endpoint.

+

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

+

Lists all subscribers registered within the owned Google Cloud Project.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates the configuration of an existing subscriber, such as the endpoint URI or the data types it's interested in. **Endpoint Verification:** If the `endpoint_uri` or `endpoint_authorization` field is included in the `update_mask`, the backend will re-verify the endpoint. The verification process is the same as described in `CreateSubscriber`: 1. **Verification with Authorization:** POST to the new or existing `endpoint_uri` with the new or existing `Authorization` secret. Expects HTTP `201 Created`. 2. **Verification without Authorization:** POST to the `endpoint_uri` without the `Authorization` header. Expects HTTP `401 Unauthorized` or `403 Forbidden`. Both tests must pass using the potentially updated values for the subscriber update to succeed. If verification fails, the update will not be applied, and an error will be returned.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, subscriberId=None, x__xgafv=None) +
Registers a new subscriber endpoint to receive notifications. A subscriber represents an application or service that wishes to receive data change notifications for users who have granted consent. **Endpoint Verification:** For a subscriber to be successfully created, the provided `endpoint_uri` must be a valid HTTPS endpoint and must pass an automated verification check. The backend will send two HTTP POST requests to the `endpoint_uri`: 1. **Verification with Authorization:** * **Headers:** Includes `Content-Type: application/json` and `Authorization` (with the exact value from `CreateSubscriberPayload.endpoint_authorization.secret`). * **Body:** `{"type": "verification"}` * **Expected Response:** HTTP `201 Created`. 2. **Verification without Authorization:** * **Headers:** Includes `Content-Type: application/json`. The `Authorization` header is OMITTED. * **Body:** `{"type": "verification"}` * **Expected Response:** HTTP `401 Unauthorized` or `403 Forbidden`. Both tests must pass for the subscriber creation to succeed. If verification fails, the operation will not be completed and an error will be returned. This process ensures the endpoint is reachable and correctly validates the `Authorization` header.
+
+Args:
+  parent: string, Required. The parent resource where this subscriber will be created. Format: projects/{project_number} Example: projects/1234567890 (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Payload for creating a subscriber.
+  "endpointAuthorization": { # Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `GOOGLE-HEALTH-API-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API. # Required. Authorization mechanism for the subscriber endpoint. The `secret` within this message is crucial for endpoint verification and for securing webhook notifications.
+    "secret": "A String", # Required. Input only. Provides a client-provided secret that will be sent with each notification to the subscriber endpoint using the "Authorization" header. The value must include the authorization scheme, e.g., "Bearer " or "Basic ", as it will be used as the full Authorization header value. This secret is used by the API to test the endpoint during `CreateSubscriber` and `UpdateSubscriber` calls, and will be sent in the `Authorization` header for all subsequent webhook notifications to this endpoint.
+    "secretSet": True or False, # Output only. Whether the secret is set.
+  },
+  "endpointUri": "A String", # Required. The full HTTPS URI where update notifications will be sent. The URI must be a valid URL and use HTTPS as the scheme. This endpoint will be verified during the `CreateSubscriber` call. See CreateSubscriber RPC documentation for verification details.
+  "subscriberConfigs": [ # Optional. Configuration for the subscriber.
+    { # Configuration for a subscriber. A notification is sent to a subscription ONLY if the subscriber has a config for the data type.
+      "dataTypes": [ # Required. See [Google Health API data types](https://developers.google.com/health/data-types) for the list of supported data types. Values should be in kebab-case.
+        "A String",
+      ],
+      "subscriptionCreatePolicy": "A String", # Required. Policy for subscription creation.
+    },
+  ],
+}
+
+  subscriberId: string, Optional. The ID to use for the subscriber, which will become the final component of the subscriber's resource name. This value should be 4-36 characters, and valid characters are /[a-z]([a-z0-9-]{2,34}[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, force=None, x__xgafv=None) +
Deletes a subscriber registration. This will stop all notifications to the subscriber's endpoint.
+
+Args:
+  name: string, Required. The name of the subscriber to delete. Format: projects/{project}/subscribers/{subscriber} Example: projects/my-project/subscribers/my-subscriber-123 The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated if not provided during creation. (required)
+  force: boolean, Optional. If set to true, any child resources (e.g., subscriptions) will also be deleted. If false (default) and child resources exist, the 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:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all subscribers registered within the owned Google Cloud Project.
+
+Args:
+  parent: string, Required. The parent, which owns this collection of subscribers. Format: projects/{project} (required)
+  pageSize: integer, Optional. The maximum number of subscribers to return. The service may return fewer than this value. If unspecified, at most 50 subscribers 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 `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListSubscribers.
+  "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.
+  "subscribers": [ # Subscribers from the specified project.
+    { # -- Resource Messages -- A subscriber receives notifications from Google Health API.
+      "createTime": "A String", # Output only. The time at which the subscriber was created.
+      "endpointAuthorization": { # Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `GOOGLE-HEALTH-API-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API. # Required. Authorization mechanism for a subscriber endpoint. This is required to ensure the endpoint can be verified.
+        "secret": "A String", # Required. Input only. Provides a client-provided secret that will be sent with each notification to the subscriber endpoint using the "Authorization" header. The value must include the authorization scheme, e.g., "Bearer " or "Basic ", as it will be used as the full Authorization header value. This secret is used by the API to test the endpoint during `CreateSubscriber` and `UpdateSubscriber` calls, and will be sent in the `Authorization` header for all subsequent webhook notifications to this endpoint.
+        "secretSet": True or False, # Output only. Whether the secret is set.
+      },
+      "endpointUri": "A String", # Required. The full HTTPS URI where update notifications will be sent. The URI must be a valid URL and use HTTPS as the scheme. This endpoint will be verified during CreateSubscriber and UpdateSubscriber calls. See RPC documentation for verification details.
+      "name": "A String", # Identifier. The resource name of the Subscriber. Format: projects/{project}/subscribers/{subscriber} The {project} ID is a Google Cloud Project ID or Project Number. The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise (e.g., a UUID). Example (User-settable subscriber ID): projects/my-project/subscribers/my-sub-123 Example (System-generated subscriber ID): projects/my-project/subscribers/a1b2c3d4-e5f6-7890-1234-567890abcdef
+      "state": "A String", # Output only. The state of the subscriber.
+      "subscriberConfigs": [ # Optional. Configuration for the subscriber.
+        { # Configuration for a subscriber. A notification is sent to a subscription ONLY if the subscriber has a config for the data type.
+          "dataTypes": [ # Required. See [Google Health API data types](https://developers.google.com/health/data-types) for the list of supported data types. Values should be in kebab-case.
+            "A String",
+          ],
+          "subscriptionCreatePolicy": "A String", # Required. Policy for subscription creation.
+        },
+      ],
+      "updateTime": "A String", # Output only. The time at which the subscriber was last updated.
+    },
+  ],
+  "totalSize": 42, # The total number of subscribers matching the request.
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the configuration of an existing subscriber, such as the endpoint URI or the data types it's interested in. **Endpoint Verification:** If the `endpoint_uri` or `endpoint_authorization` field is included in the `update_mask`, the backend will re-verify the endpoint. The verification process is the same as described in `CreateSubscriber`: 1. **Verification with Authorization:** POST to the new or existing `endpoint_uri` with the new or existing `Authorization` secret. Expects HTTP `201 Created`. 2. **Verification without Authorization:** POST to the `endpoint_uri` without the `Authorization` header. Expects HTTP `401 Unauthorized` or `403 Forbidden`. Both tests must pass using the potentially updated values for the subscriber update to succeed. If verification fails, the update will not be applied, and an error will be returned.
+
+Args:
+  name: string, Identifier. The resource name of the Subscriber. Format: projects/{project}/subscribers/{subscriber} The {project} ID is a Google Cloud Project ID or Project Number. The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise (e.g., a UUID). Example (User-settable subscriber ID): projects/my-project/subscribers/my-sub-123 Example (System-generated subscriber ID): projects/my-project/subscribers/a1b2c3d4-e5f6-7890-1234-567890abcdef (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # -- Resource Messages -- A subscriber receives notifications from Google Health API.
+  "createTime": "A String", # Output only. The time at which the subscriber was created.
+  "endpointAuthorization": { # Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `GOOGLE-HEALTH-API-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API. # Required. Authorization mechanism for a subscriber endpoint. This is required to ensure the endpoint can be verified.
+    "secret": "A String", # Required. Input only. Provides a client-provided secret that will be sent with each notification to the subscriber endpoint using the "Authorization" header. The value must include the authorization scheme, e.g., "Bearer " or "Basic ", as it will be used as the full Authorization header value. This secret is used by the API to test the endpoint during `CreateSubscriber` and `UpdateSubscriber` calls, and will be sent in the `Authorization` header for all subsequent webhook notifications to this endpoint.
+    "secretSet": True or False, # Output only. Whether the secret is set.
+  },
+  "endpointUri": "A String", # Required. The full HTTPS URI where update notifications will be sent. The URI must be a valid URL and use HTTPS as the scheme. This endpoint will be verified during CreateSubscriber and UpdateSubscriber calls. See RPC documentation for verification details.
+  "name": "A String", # Identifier. The resource name of the Subscriber. Format: projects/{project}/subscribers/{subscriber} The {project} ID is a Google Cloud Project ID or Project Number. The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise (e.g., a UUID). Example (User-settable subscriber ID): projects/my-project/subscribers/my-sub-123 Example (System-generated subscriber ID): projects/my-project/subscribers/a1b2c3d4-e5f6-7890-1234-567890abcdef
+  "state": "A String", # Output only. The state of the subscriber.
+  "subscriberConfigs": [ # Optional. Configuration for the subscriber.
+    { # Configuration for a subscriber. A notification is sent to a subscription ONLY if the subscriber has a config for the data type.
+      "dataTypes": [ # Required. See [Google Health API data types](https://developers.google.com/health/data-types) for the list of supported data types. Values should be in kebab-case.
+        "A String",
+      ],
+      "subscriptionCreatePolicy": "A String", # Required. Policy for subscription creation.
+    },
+  ],
+  "updateTime": "A String", # Output only. The time at which the subscriber was last updated.
+}
+
+  updateMask: string, Optional. A field mask that specifies which fields of the Subscriber message are to be updated. This allows for partial updates. Supported fields: - endpoint_uri - subscriber_configs - endpoint_authorization
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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/health_v4beta.projects.subscribers.subscriptions.html b/docs/dyn/health_v4beta.projects.subscribers.subscriptions.html new file mode 100644 index 0000000000..9a54d6f3ab --- /dev/null +++ b/docs/dyn/health_v4beta.projects.subscribers.subscriptions.html @@ -0,0 +1,233 @@ + + + +

Google Health API . projects . subscribers . subscriptions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a subscription for a specific user to a specific subscriber. This method requires the subscriber to have a `SubscriptionCreatePolicy` set to `MANUAL` for the given data types.

+

+ delete(name, x__xgafv=None)

+

Deletes a specific user subscription, stopping notifications for this user to this subscriber.

+

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

+

Lists all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates the data types for an existing user subscription.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, subscriptionId=None, x__xgafv=None) +
Creates a subscription for a specific user to a specific subscriber. This method requires the subscriber to have a `SubscriptionCreatePolicy` set to `MANUAL` for the given data types.
+
+Args:
+  parent: string, Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Payload for creating a subscription.
+  "dataTypes": [ # Optional. Data types subscribed to.
+    "A String",
+  ],
+  "user": "A String", # Required. Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).
+}
+
+  subscriptionId: string, Optional. The {subscription_id} is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise. If provided, the ID must be unique within the parent subscriber.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A subscription to a data collection for a specific user, to be delivered to a subscriber.
+  "dataTypes": [ # Optional. Data types subscribed to. A subscriber will only receive notifications for data types that are declared here. A subscription can only subscribe to the data types of the subscriber. The values should be in the format "users/{health_user_id}/dataTypes/{data_type}" where `{data_type}` is one of "altitude", "distance", "floors", "sleep", "steps", "weight".
+    "A String",
+  ],
+  "name": "A String", # Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise.
+  "user": "A String", # Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a specific user subscription, stopping notifications for this user to this subscriber.
+
+Args:
+  name: string, Required. The resource name of the subscription to delete. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated if not provided during creation. (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); }
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.
+
+Args:
+  parent: string, Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. (required)
+  filter: string, Optional. A filter to apply to the list of subscriptions. The filter syntax is described in https://google.aip.dev/160. The filter can be applied to the following fields: - `user` - `data_type` The `user` identifier (e.g., `user1` in `users/user1`) refers to the public `health_user_id` Example: user = "users/user1" Example: user = "users/user1" OR user = "users/user2" Example: user = "users/user1" AND (data_type = "sleep" OR data_type = "weight")
+  pageSize: integer, Optional. The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions 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 `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptions` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListSubscriptions.
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "subscriptions": [ # The subscriptions from the specified subscriber.
+    { # A subscription to a data collection for a specific user, to be delivered to a subscriber.
+      "dataTypes": [ # Optional. Data types subscribed to. A subscriber will only receive notifications for data types that are declared here. A subscription can only subscribe to the data types of the subscriber. The values should be in the format "users/{health_user_id}/dataTypes/{data_type}" where `{data_type}` is one of "altitude", "distance", "floors", "sleep", "steps", "weight".
+        "A String",
+      ],
+      "name": "A String", # Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise.
+      "user": "A String", # Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).
+    },
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the data types for an existing user subscription.
+
+Args:
+  name: string, Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A subscription to a data collection for a specific user, to be delivered to a subscriber.
+  "dataTypes": [ # Optional. Data types subscribed to. A subscriber will only receive notifications for data types that are declared here. A subscription can only subscribe to the data types of the subscriber. The values should be in the format "users/{health_user_id}/dataTypes/{data_type}" where `{data_type}` is one of "altitude", "distance", "floors", "sleep", "steps", "weight".
+    "A String",
+  ],
+  "name": "A String", # Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise.
+  "user": "A String", # Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).
+}
+
+  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:
+
+    { # A subscription to a data collection for a specific user, to be delivered to a subscriber.
+  "dataTypes": [ # Optional. Data types subscribed to. A subscriber will only receive notifications for data types that are declared here. A subscription can only subscribe to the data types of the subscriber. The values should be in the format "users/{health_user_id}/dataTypes/{data_type}" where `{data_type}` is one of "altitude", "distance", "floors", "sleep", "steps", "weight".
+    "A String",
+  ],
+  "name": "A String", # Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise.
+  "user": "A String", # Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/health_v4beta.shl.html b/docs/dyn/health_v4beta.shl.html new file mode 100644 index 0000000000..e07cf54160 --- /dev/null +++ b/docs/dyn/health_v4beta.shl.html @@ -0,0 +1,96 @@ + + + +

Google Health API . shl

+

Instance Methods

+

+ m() +

+

Returns the m Resource.

+ +

+ r() +

+

Returns the r Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/health_v4beta.shl.m.html b/docs/dyn/health_v4beta.shl.m.html new file mode 100644 index 0000000000..6b922a3274 --- /dev/null +++ b/docs/dyn/health_v4beta.shl.m.html @@ -0,0 +1,123 @@ + + + +

Google Health API . shl . m

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ getShlManifest(externalShlId, body=None, x__xgafv=None)

+

Forward a manifest request for a given SHL

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getShlManifest(externalShlId, body=None, x__xgafv=None) +
Forward a manifest request for a given SHL
+
+Args:
+  externalShlId: string, Required. External ID mapping to a ShlSharedLinkCapabilityToken object See https://docs.google.com/document/d/1Pch20pxJHRbsaMxp0EYgs3ZU0Gu7QTUznk8LhvbQvfY/edit?tab=t.0#heading=h.17wg41voij6q (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents the POST body contained in a GetShlManifestRequest This message is nested to represent that See https://build.fhir.org/ig/HL7/smart-health-cards-and-links/links-specification.html#smart-health-link-manifest-request
+  "embeddedLengthMax": 42, # Optional. Integer upper bound on the length of embedded payloads
+  "passcode": "A String", # Optional.
+  "recipient": "A String", # Required. A string describing the recipient (e.g.,the name of an organization or person) suitable for display to the Receiving User
+}
+
+  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/health_v4beta.shl.r.html b/docs/dyn/health_v4beta.shl.r.html new file mode 100644 index 0000000000..83fc24d022 --- /dev/null +++ b/docs/dyn/health_v4beta.shl.r.html @@ -0,0 +1,115 @@ + + + +

Google Health API . shl . r

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(externalShlId, resourceToken, x__xgafv=None)

+

Forward a resource request for a given SHL

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(externalShlId, resourceToken, x__xgafv=None) +
Forward a resource request for a given SHL
+
+Args:
+  externalShlId: string, Required. External ID mapping to a ShlSharedLinkCapabilityToken object See https://docs.google.com/document/d/1Pch20pxJHRbsaMxp0EYgs3ZU0Gu7QTUznk8LhvbQvfY/edit?tab=t.0#heading=h.17wg41voij6q (required)
+  resourceToken: string, Required. Encoded, encrypted message containing resource access details (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/health_v4beta.users.dataTypes.dataPoints.html b/docs/dyn/health_v4beta.users.dataTypes.dataPoints.html new file mode 100644 index 0000000000..3f3606ca86 --- /dev/null +++ b/docs/dyn/health_v4beta.users.dataTypes.dataPoints.html @@ -0,0 +1,7559 @@ + + + +

Google Health API . users . dataTypes . dataPoints

+

Instance Methods

+

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

+

Delete a batch of identifyable data points.

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a single identifiable data point.

+

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

+

Roll up data points over civil time intervals for supported data types.

+

+ exportExerciseTcx(name, partialData=None, x__xgafv=None)

+

Exports exercise data in TCX format. **IMPORTANT:** HTTP clients must append `?alt=media` to the request URL to download the raw TCX file. Example: `https://health.googleapis.com/v4/users/me/dataTypes/exercise/dataPoints/EXERCISE_ID:exportExerciseTcx?alt=media` Without `alt=media`, the server returns a JSON response (`ExportExerciseTcxResponse`) which is intended primarily for gRPC clients. **Note:** While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.

+

+ exportExerciseTcx_media(name, partialData=None, x__xgafv=None)

+

Exports exercise data in TCX format. **IMPORTANT:** HTTP clients must append `?alt=media` to the request URL to download the raw TCX file. Example: `https://health.googleapis.com/v4/users/me/dataTypes/exercise/dataPoints/EXERCISE_ID:exportExerciseTcx?alt=media` Without `alt=media`, the server returns a JSON response (`ExportExerciseTcxResponse`) which is intended primarily for gRPC clients. **Note:** While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.

+

+ get(name, x__xgafv=None)

+

Get a single identifyable data point.

+

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

+

Query user health and fitness data points.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates a single identifiable data point. If a data point with the specified `name` is not found, the request will fail.

+

+ reconcile(parent, dataSourceFamily=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Reconcile data points from multiple data sources into a single data stream.

+

+ reconcile_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Roll up data points over physical time intervals for supported data types.

+

+ rollUp_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ batchDelete(parent, body=None, x__xgafv=None) +
Delete a batch of identifyable data points.
+
+Args:
+  parent: string, Optional. Parent (data type) for the Data Point collection Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/-` For a list of the supported data types see the DataPoint data union field. Deleting data points across multiple data type collections is supported following https://aip.dev/159. If this is set, the parent of all of the data points specified in `names` must match this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to delete a batch of identifiable data points.
+  "names": [ # Required. The names of the DataPoints to delete. A maximum of 10000 data points can be deleted in a single request.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a single identifiable data point.
+
+Args:
+  parent: string, Required. The parent resource name where the data point will be created. Format: `users/{user}/dataTypes/{data_type}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A computed or recorded metric.
+  "activeEnergyBurned": { # Energy burned as part of an activity, excluding the basal energy burn. # Optional. Data for points in the `active-energy-burned` 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).
+    },
+    "kcal": 3.14, # Required. Energy burned during an activity, measured in kilocalories.
+  },
+  "activeMinutes": { # Record of active minutes in a given time interval. # Optional. Data for points in the `active-minutes` interval data type collection.
+    "activeMinutesByActivityLevel": [ # Required. Active minutes by activity level. At most one record per activity level is allowed.
+      { # Active minutes at a given activity level.
+        "activeMinutes": "A String", # Required. Number of whole minutes spent in activity.
+        "activityLevel": "A String", # Required. The level of activity.
+      },
+    ],
+    "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).
+    },
+  },
+  "activeZoneMinutes": { # Record of active zone minutes in a given time interval. # Optional. Data for points in the `active-zone-minutes` interval data type collection, measured in minutes.
+    "activeZoneMinutes": "A String", # Required. Number of Active Zone Minutes earned in the given time interval. Note: active_zone_minutes equals to 1 for low intensity (fat burn) zones or 2 for high intensity zones (cardio, peak).
+    "heartRateZone": "A String", # Required. Heart rate zone in which the active zone minutes have been earned, in the given time interval.
+    "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).
+    },
+  },
+  "activityLevel": { # Internal type to capture activity level during a certain time interval. # Optional. Data for points in the `activity-level` daily data type collection.
+    "activityLevelType": "A String", # Required. Activity level type in the given time interval.
+    "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).
+    },
+  },
+  "altitude": { # Captures the altitude gain (i.e. deltas), and not level above sea, for a user in millimeters. # Optional. Data for points in the `altitude` interval data type collection.
+    "gainMillimeters": "A String", # Required. Altitude gain in millimeters over the observed interval.
+    "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).
+    },
+  },
+  "basalEnergyBurned": { # Number of calories burned due to basal metabolic rate (BMR) over a period of time. # Optional. Data for points in the `basal-energy-burned` 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).
+    },
+    "kcal": 3.14, # Required. Number of calories burned due to basal metabolic rate in kilocalories over the observed interval.
+  },
+  "bloodGlucose": { # Represents a blood glucose level measurement. LINT: LEGACY_NAMES # Optional. Data for points in the `blood-glucose` sample data type collection.
+    "bloodGlucoseMilligramsPerDeciliter": 3.14, # Required. Blood glucose level concentration in mg/dL.
+    "mealType": "A String", # Optional. Meal type of the measurement.
+    "measurementSource": "A String", # Optional. Source of the measurement.
+    "measurementTiming": "A String", # Optional. Timing of the measurement.
+    "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which blood glucose 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).
+    },
+    "specimen": "A String", # Optional. Type of body fluid used to measure the blood glucose.
+  },
+  "bodyFat": { # Body fat measurement. # Optional. Data for points in the `body-fat` sample data type collection.
+    "percentage": 3.14, # Required. Body fat percentage, in range [0, 100].
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which body fat 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).
+    },
+  },
+  "coreBodyTemperature": { # Core body temperature measurement, distinct from peripheral body temperature, reflects the temperature of the body's internal organs. # Optional. Data for points in the `core-body-temperature` sample data type collection.
+    "id": "A String", # Optional. The unique identifier of the core body temperature measurement.
+    "measurementLocation": "A String", # Optional. The location of the core body temperature measurement.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which core body temperature 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).
+    },
+    "temperatureCelsius": 3.14, # Required. The core body temperature in Celsius.
+  },
+  "dailyHeartRateVariability": { # Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds` # Optional. Data for points in the `daily-heart-rate-variability` daily data type collection.
+    "averageHeartRateVariabilityMilliseconds": 3.14, # Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats.
+    "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. Date (in the user's timezone) of heart rate variability measurement.
+      "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.
+    },
+    "deepSleepRootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences (RMSSD) value during deep sleep.
+    "entropy": 3.14, # Optional. The Shanon entropy of heartbeat intervals. Entropy quantifies randomness or disorder in a system. High entropy indicates high HRV. Entropy is measured from the histogram of time interval between successive heart beats values measured during sleep.
+    "nonRemHeartRateBeatsPerMinute": "A String", # Optional. Non-REM heart rate
+  },
+  "dailyHeartRateZones": { # User's heart rate zone thresholds based on the Karvonen algorithm for a specific day. # Optional. Data for points in the `daily-heart-rate-zones` daily data type collection.
+    "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. Date (in user's timezone) of the heart rate zones record.
+      "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.
+    },
+    "heartRateZones": [ # Required. The heart rate zones.
+      { # The heart rate zone.
+        "heartRateZoneType": "A String", # Required. The heart rate zone type.
+        "maxBeatsPerMinute": "A String", # Required. Maximum heart rate for this zone in beats per minute.
+        "minBeatsPerMinute": "A String", # Required. Minimum heart rate for this zone in beats per minute.
+      },
+    ],
+  },
+  "dailyOxygenSaturation": { # A daily oxygen saturation (SpO2) record. Represents the user's daily oxygen saturation summary, typically calculated during sleep. # Optional. Data for points in the `daily-oxygen-saturation` daily data type collection.
+    "averagePercentage": 3.14, # Required. The average value of the oxygen saturation samples during the sleep.
+    "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. Date (in user's timezone) of the daily oxygen saturation record.
+      "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.
+    },
+    "lowerBoundPercentage": 3.14, # Required. The lower bound of the confidence interval of oxygen saturation samples during sleep.
+    "standardDeviationPercentage": 3.14, # Optional. Standard deviation of the daily oxygen saturation averages from the past 7-30 days.
+    "upperBoundPercentage": 3.14, # Required. The upper bound of the confidence interval of oxygen saturation samples during sleep.
+  },
+  "dailyRespiratoryRate": { # A daily average respiratory rate (breaths per minute) for a day of the year. One data point per day calculated for the main sleep. # Optional. Data for points in the `daily-respiratory-rate` daily data type collection.
+    "breathsPerMinute": 3.14, # Required. The average number of breaths taken per minute.
+    "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. The date on which the respiratory rate was measured.
+      "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.
+    },
+  },
+  "dailyRestingHeartRate": { # Measures the daily resting heart rate for a user, calculated using the all day heart rate measurements. # Optional. Data for points in the `daily-resting-heart-rate` daily data type collection.
+    "beatsPerMinute": "A String", # Required. The resting heart rate value in beats per minute.
+    "dailyRestingHeartRateMetadata": { # Metadata for the daily resting heart rate. # Optional. Metadata for the daily resting heart rate.
+      "calculationMethod": "A String", # Required. The method used to calculate the resting heart rate.
+    },
+    "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. Date (in the user's timezone) of the resting heart rate measurement.
+      "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.
+    },
+  },
+  "dailySleepTemperatureDerivations": { # Provides derived sleep temperature values, calculated from skin or internal device temperature readings during sleep. # Optional. Data for points in the `daily-sleep-temperature-derivations` daily data type collection.
+    "baselineTemperatureCelsius": 3.14, # Optional. The user's baseline skin temperature. It is the median of the user's nightly skin temperature over the past 30 days.
+    "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. Date for which the sleep temperature derivations are calculated.
+      "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.
+    },
+    "nightlyTemperatureCelsius": 3.14, # Required. The user's nightly skin temperature. It is the mean of skin temperature samples taken from the user’s sleep.
+    "relativeNightlyStddev30dCelsius": 3.14, # Optional. The standard deviation of the user’s relative nightly skin temperature (temperature - baseline) over the past 30 days.
+  },
+  "dailyVo2Max": { # Contains a daily summary of the user's VO2 max (cardio fitness score), which is the maximum rate of oxygen the body can use during exercise. # Optional. Data for points in the `daily-vo2-max` daily data type collection.
+    "cardioFitnessLevel": "A String", # Optional. Represents the user's cardio fitness level based on their VO2 max.
+    "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. The date for which the Daily VO2 max was measured.
+      "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.
+    },
+    "estimated": True or False, # Optional. An estimated field is added to indicate when the confidence has decreased sufficiently to consider the value an estimation.
+    "vo2Max": 3.14, # Required. Daily VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+    "vo2MaxCovariance": 3.14, # Optional. The covariance of the VO2 max value.
+  },
+  "dataSource": { # Data Source definition to track the origin of data. Each health data point, regardless of the complexity or data model (whether a simple step count or a detailed sleep session) must retain information about its source of origin (e.g. the device or app that collected it). # Optional. Data source information for the metric
+    "application": { # Optional metadata for the application that provided this data. # Output only. Captures metadata for the application that provided this data.
+      "googleWebClientId": "A String", # Output only. The Google OAuth 2.0 client ID of the web application or service that recorded the data. This is the client ID used during the Google OAuth flow to obtain user credentials. This field is system-populated when the data is uploaded from Google Web API.
+      "packageName": "A String", # Output only. A unique identifier for the mobile application that was the source of the data. This is typically the application's package name on Android (e.g., `com.google.fitbit`) or the bundle ID on iOS. This field is informational and helps trace data origin. This field is system-populated when the data is uploaded from the Fitbit mobile application, Health Connect or Health Kit.
+      "webClientId": "A String", # Output only. The client ID of the application that recorded the data. This ID is a legacy Fitbit API client ID, which is different from a Google OAuth client ID. Example format: `ABC123`. This field is system-populated and used for tracing data from legacy Fitbit API integrations. This field is system-populated when the data is uploaded from a legacy Fitbit API integration.
+    },
+    "device": { # Captures metadata about the device that recorded the measurement. # Optional. Captures metadata for raw data points originating from devices. We expect this data source to be used for data points written on device sync.
+      "displayName": "A String", # Optional. An optional name for the device.
+      "formFactor": "A String", # Optional. Captures the form factor of the device.
+      "manufacturer": "A String", # Optional. An optional manufacturer of the device.
+    },
+    "platform": "A String", # Output only. Captures the platform that uploaded the data.
+    "recordingMethod": "A String", # Optional. Captures how the data was recorded.
+  },
+  "distance": { # Distance traveled over an interval of time. # Optional. Data for points in the `distance` 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).
+    },
+    "millimeters": "A String", # Required. Distance in millimeters over the observed interval.
+  },
+  "electrocardiogram": { # Represents an Electrocardiogram (ECG) measurement session. This data type is based on SaMD feature and any changes to it may require additional review. # Optional. Data for points in the `electrocardiogram` session data type collection.
+    "beatsPerMinuteAvg": "A String", # Optional. Average heart rate recorded during ECG reading in beats per minute.
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. NOTE: Historical ECG data lacks timezone offsets, so `start_utc_offset` and `end_utc_offset` will be missing or default to zero. As a result, the civil time fields within this interval will default to UTC. It is recommended to use physical time fields instead for accurate time referencing. NOTE: The `start_time` and `end_time` of the interval are equal, representing the reading time.
+      "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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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).
+    },
+    "leadNumber": 42, # Optional. The number of leads used for ECG reading.
+    "medicalDeviceInfo": { # Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI). # Output only. The meta information for the compatible device used to conduct the measurement. ECG measurements typically populate `firmware_version`, `feature_version`, and `device_model`.
+      "algorithmVersion": "A String", # Output only. The algorithm version used by the feature.
+      "deviceModel": "A String", # Output only. The model name or device type of the compatible device used to collect the data.
+      "featureVersion": "A String", # Output only. The version of the feature/app running on the device.
+      "firmwareVersion": "A String", # Output only. The firmware version running on the compatible device used to collect the data.
+      "serviceVersion": "A String", # Output only. The service version used by the feature.
+    },
+    "millivoltsScalingFactor": 42, # Optional. The factor by which to divide waveform samples to get voltage in millivolts: millivolts = waveform_sample / millivolts_scaling_factor.
+    "resultClassification": "A String", # Optional. The result classification of the ECG reading.
+    "samplingFrequencyHertz": 42, # Optional. The sampling frequency of waveform samples in hertz.
+    "waveformSamples": [ # Optional. An array of voltage values representing lead I ECG values. Each sample represents voltage difference in ECG graph. The first value in array corresponds to the start of the reading.
+      42,
+    ],
+  },
+  "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. 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
+        "eventUtcOffset": "A String", # Required. Exercise event time offset from UTC
+        "exerciseEventType": "A String", # Required. The type of the event, such as start, stop, pause, resume.
+      },
+    ],
+    "exerciseMetadata": { # Additional exercise metadata. # Optional. Additional exercise metadata.
+      "hasGps": True or False, # Optional. Whether the exercise had GPS tracking.
+      "poolLengthMillimeters": "A String", # Optional. Pool length in millimeters. Only present in the swimming exercises.
+    },
+    "exerciseType": "A String", # Required. The type of activity performed during an exercise.
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed exercise 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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).
+    },
+    "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this exercise ( )
+      "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+      "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+      "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+      "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+      "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+      "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+      "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+      "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+        "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+        "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+        "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+        "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+      },
+      "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+        "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+        "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+        "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+        "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+        "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+      },
+      "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+      "steps": "A String", # Optional. Total steps taken during the exercise.
+      "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+    },
+    "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+    "splitSummaries": [ # Optional. Laps or splits recorded within an exercise. Laps could be split based on distance or other criteria (duration, etc.) Laps should not be overlapping with each other.
+      { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+        "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+        "endTime": "A String", # Required. Lap end time
+        "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+        "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+          "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+          "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+          "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+          "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+          "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+          "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+          "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+          "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+            "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+            "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+            "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+            "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+          },
+          "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+            "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+            "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+            "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+            "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+            "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+          },
+          "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+          "steps": "A String", # Optional. Total steps taken during the exercise.
+          "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+        },
+        "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+        "startTime": "A String", # Required. Lap start time
+        "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+      },
+    ],
+    "splits": [ # Optional. The default split is 1 km or 1 mile. - if the movement distance is less than the default, then there are no splits - if the movement distance is greater than or equal to the default, then we have splits
+      { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+        "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+        "endTime": "A String", # Required. Lap end time
+        "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+        "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+          "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+          "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+          "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+          "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+          "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+          "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+          "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+          "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+            "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+            "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+            "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+            "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+          },
+          "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+            "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+            "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+            "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+            "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+            "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+          },
+          "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+          "steps": "A String", # Optional. Total steps taken during the exercise.
+          "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+        },
+        "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+        "startTime": "A String", # Required. Lap start time
+        "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+      },
+    ],
+    "updateTime": "A String", # Output only. This is the timestamp of the last update to the exercise.
+  },
+  "floors": { # Gained elevation measured in floors over the time interval # Optional. Data for points in the `floors` interval data type collection.
+    "count": "A String", # Required. Number of floors in the recorded interval
+    "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).
+    },
+  },
+  "food": { # Represents a food item. # Optional. The food details.
+    "accessLevel": "A String", # Required. The access level of the food.
+    "brand": "A String", # Optional. The brand of the food.
+    "defaultServing": { # Represents different properties and information about the serving of a specific food. # Required. Value representing the default serving of the food.
+      "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported.
+      "foodMeasurementUnit": "A String", # Required. Food measurement unit
+      "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram").
+      "foodMeasurementUnitDisplayNamePlural": "A String", # Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams").
+      "multiplier": 3.14, # Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving.
+    },
+    "description": "A String", # Optional. The description of the food.
+    "displayName": "A String", # Required. The display name of the food.
+    "energyAvg": { # Represents the energy quantity. # Optional. Value representing the average energy of the food for the default serving.
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the food for the default serving.
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "energyMax": { # Represents the energy quantity. # Optional. Value representing the maximum energy of the food for the default serving.
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "energyMin": { # Represents the energy quantity. # Optional. Value representing the minimum energy of the food for the default serving.
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "languageCode": "A String", # Optional. The language code where the food is available in format xx-XX. Supported values are defined in Settings.food_language_code.
+    "mealType": "A String", # Optional. The meal type associated with this food.
+    "nutrients": [ # Optional. Value representing the nutrients of the food for the default serving.
+      { # Represents the quantity of a nutrient.
+        "nutrient": "A String", # Required. The nutrient type.
+        "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams.
+          "grams": 3.14, # Required. The weight value in grams.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+      },
+    ],
+    "servings": [ # Optional. The serving of the food.
+      { # Represents different properties and information about the serving of a specific food.
+        "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported.
+        "foodMeasurementUnit": "A String", # Required. Food measurement unit
+        "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram").
+        "foodMeasurementUnitDisplayNamePlural": "A String", # Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams").
+        "multiplier": 3.14, # Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving.
+      },
+    ],
+    "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the food for the default serving.
+      "grams": 3.14, # Required. The weight value in grams.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the food for the default serving.
+      "grams": 3.14, # Required. The weight value in grams.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+  },
+  "foodMeasurementUnit": { # Represents a food measurement unit. # Optional. The food measurement unit details.
+    "displayName": "A String", # Required. The display name of the food measurement unit (e.g., "gram", "piece").
+    "pluralDisplayName": "A String", # Optional. The plural display name of the food measurement unit (e.g., "grams", "pieces").
+  },
+  "heartRate": { # A heart rate measurement. # Optional. Data for points in the `heart-rate` sample data type collection.
+    "beatsPerMinute": "A String", # Required. The heart rate value in beats per minute.
+    "metadata": { # Heart rate metadata. # Optional. Metadata about the heart rate sample.
+      "motionContext": "A String", # Optional. Indicates the user’s level of activity when the heart rate sample was measured
+      "sensorLocation": "A String", # Optional. Indicates the location of the sensor that measured the heart rate.
+    },
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. Observation time
+      "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).
+    },
+  },
+  "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection.
+    "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces.
+      "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz).
+      "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz).
+    },
+    "rootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time of the heart rate variability measurement.
+      "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).
+    },
+    "standardDeviationMilliseconds": 3.14, # Optional. The standard deviation of the heart rate variability measurement.
+  },
+  "height": { # Body height measurement. # Optional. Data for points in the `height` sample data type collection.
+    "heightMillimeters": "A String", # Required. Height of the user in millimeters.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the height was recorded.
+      "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).
+    },
+  },
+  "hydrationLog": { # Holds information about a user logged hydration. # Optional. Data for points in the `hydration-log` session data type collection.
+    "amountConsumed": { # Represents the volume quantity. # Required. Amount of liquid (ex. water) consumed.
+      "milliliters": 3.14, # Required. Value representing the volume in milliliters.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit, used only for user-facing input and display purposes. In the API format, all volume quantities are converted to milliliters.
+    },
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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).
+    },
+  },
+  "irregularRhythmNotification": { # Represents an Irregular Rhythm Notification alert, indicating a potential sign of atrial fibrillation (AFib). This data type is based on SaMD feature and any changes to it may require additional review. # Optional. Data for points in the `irregular-rhythm-notification` session data type collection.
+    "alertWindows": [ # Optional. The overlapping analysis windows that were used to evaluate rhythm for potential AFib, containing specific information about the user's heart rhythm.
+      { # An analysis window evaluated for AFib. Note: The current version of the algorithm will only produce alerts if all windows are positive. So anything returned from the API will always have the positive bit set to true. Internally, windows can be negative, however. We never save "inconclusive" windows (they aren't produced by the algorithm).
+        "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. The end time of the analysis window.
+        "endUtcOffset": "A String", # Required. The UTC offset of the user's timezone when the analysis window ended.
+        "heartBeats": [ # Optional. All heart beats in the interval contained in this analysis window.
+          { # A single heart beat measurement.
+            "beatsPerMinute": 42, # Required. The beats-per-minute value extrapolated from the time before the following heart beat. This is calculated as 60000 / rr, where rr is the gap between heart beats in milliseconds (IBI - Interbeat Interval).
+            "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 heart beat measurement.
+            "utcOffset": "A String", # Required. The UTC offset of the user's timezone when the heart beat measurement occurred.
+          },
+        ],
+        "positive": True or False, # Optional. Flag indicating whether the window was positive for AFib or not. A `true` value indicates that AFib was detected in this window. A `false` value means AFib was not detected, but does not guarantee the absence of AFib.
+        "startTime": "A String", # Required. Observed interval. The start time of the analysis window.
+        "startUtcOffset": "A String", # Required. The UTC offset of the user's timezone when the analysis window started.
+      },
+    ],
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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).
+    },
+    "medicalDeviceInfo": { # Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI). # Output only. The meta information for the compatible device used to conduct the measurement. Irregular Rhythm Notification measurements typically populate `algorithm_version`, `service_version`, and `device_model`.
+      "algorithmVersion": "A String", # Output only. The algorithm version used by the feature.
+      "deviceModel": "A String", # Output only. The model name or device type of the compatible device used to collect the data.
+      "featureVersion": "A String", # Output only. The version of the feature/app running on the device.
+      "firmwareVersion": "A String", # Output only. The firmware version running on the compatible device used to collect the data.
+      "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`).
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "energyFromFat": { # Represents the energy quantity. # Optional. The energy from fat, measured in kilocalories (`kcal`).
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "food": "A String", # Optional. The resource name of the Food item. Required when creating a nutrition log from an identified food. For anonymous food logs, use the `food_display_name` field instead.
+    "foodDisplayName": "A String", # The display name of the food. For identified food logs, this is populated automatically from the referenced food.
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. The time window when the food was logged.
+      "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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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).
+    },
+    "mealType": "A String", # Optional. The meal category. One of `BREAKFAST`, `LUNCH`, `DINNER`, or `SNACK`.
+    "nutrients": [ # Optional. An array of individual nutrient values for the nutrition log.
+      { # Represents the quantity of a nutrient.
+        "nutrient": "A String", # Required. The nutrient type.
+        "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams.
+          "grams": 3.14, # Required. The weight value in grams.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+      },
+    ],
+    "serving": { # Represents different properties and information about the serving of a specific food. # Optional. The serving information for the logged food.
+      "amount": 3.14, # Optional. The number of servings.
+      "foodMeasurementUnit": "A String", # Required. Food measurement unit
+      "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram").
+    },
+    "totalCarbohydrate": { # Represents the weight quantity. # Optional. The total carbohydrate content, measured in grams.
+      "grams": 3.14, # Required. The weight value in grams.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "totalFat": { # Represents the weight quantity. # Optional. The total fat content, measured in grams.
+      "grams": 3.14, # Required. The weight value in grams.
+      "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.
+      "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).
+    },
+  },
+  "respiratoryRateSleepSummary": { # Records respiratory rate details during sleep. Can have multiple per day if the user sleeps multiple times. # Optional. Data for points in the `respiratory-rate-sleep-summary` sample data type collection.
+    "deepSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for deep sleep.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "fullSleepStats": { # Respiratory rate statistics for a given sleep stage. # Required. Full respiratory rate statistics.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "lightSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for light sleep.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "remSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for REM sleep.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which respiratory rate 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).
+    },
+  },
+  "runVo2Max": { # VO2 max value calculated based on the user's running activity. Value stored in ml/kg/min. # Optional. Data for points in the `run-vo2-max` sample data type collection.
+    "runVo2Max": 3.14, # Required. Run VO2 max value in ml/kg/min.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the metric 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).
+    },
+  },
+  "sedentaryPeriod": { # SedentaryPeriod SedentaryPeriod data represents the periods of time that the user was sedentary (i.e. not moving while wearing the device). # Optional. Data for points in the `sedentary-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).
+    },
+  },
+  "sleep": { # A sleep session possibly including stages. # Optional. Data for points in the `sleep` session data type collection.
+    "createTime": "A String", # Output only. Creation time of this sleep observation.
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed sleep 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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: `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.
+      "stagesStatus": "A String", # Output only. Sleep stages algorithm processing status.
+    },
+    "outOfBedSegments": [ # Optional. “Out of bed” segments that can overlap with sleep stages.
+      { # A time interval to represent an out-of-bed segment.
+        "endTime": "A String", # Required. Segment end time.
+        "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the segment relative to the Coordinated Universal Time (UTC).
+        "startTime": "A String", # Required. Segment tart time.
+        "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the segment relative to the Coordinated Universal Time (UTC).
+      },
+    ],
+    "shortAwakenings": [ # Output only. List of short awake segments (under a set threshold) that are part of the sleep session. These can overlap with sleep stages.
+      { # Sleep stage segment.
+        "createTime": "A String", # Output only. Creation time of this sleep stages segment.
+        "endTime": "A String", # Required. Sleep stage end time.
+        "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC).
+        "startTime": "A String", # Required. Sleep stage start time.
+        "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC).
+        "type": "A String", # Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+        "updateTime": "A String", # Output only. Last update time of this sleep stages segment.
+      },
+    ],
+    "stages": [ # Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.
+      { # Sleep stage segment.
+        "createTime": "A String", # Output only. Creation time of this sleep stages segment.
+        "endTime": "A String", # Required. Sleep stage end time.
+        "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC).
+        "startTime": "A String", # Required. Sleep stage start time.
+        "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC).
+        "type": "A String", # Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+        "updateTime": "A String", # Output only. Last update time of this sleep stages segment.
+      },
+    ],
+    "summary": { #  Sleep summary: metrics and stages summary. # Output only. Sleep summary: metrics and stages summary.
+      "minutesAfterWakeUp": "A String", # Output only. Minutes after wake up calculated by restlessness algorithm.
+      "minutesAsleep": "A String", # Output only. Total number of minutes asleep. For classic sleep it is the sum of ASLEEP stages (excluding AWAKE and RESTLESS). For "stages" sleep it is the sum of LIGHT, REM and DEEP stages (excluding AWAKE).
+      "minutesAwake": "A String", # Output only. Total number of minutes awake. It is a sum of all AWAKE stages.
+      "minutesInSleepPeriod": "A String", # Output only. Delta between wake time and bedtime. It is the sum of all stages.
+      "minutesToFallAsleep": "A String", # Output only. Minutes to fall asleep calculated by restlessness algorithm.
+      "stagesSummary": [ # Output only. List of summaries (total duration and segment count) per each sleep stage type.
+        { # Total duration and segment count for a stage.
+          "count": "A String", # Output only. Number of sleep stages segments.
+          "minutes": "A String", # Output only. Total duration in minutes of a sleep stage.
+          "type": "A String", # Output only. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+        },
+      ],
+    },
+    "type": "A String", # Optional. SleepType: classic or stages.
+    "updateTime": "A String", # Output only. Last update time of this sleep observation.
+  },
+  "steps": { # Step count over the time interval. # Optional. Data for points in the `steps` interval data type collection.
+    "count": "A String", # Required. Number of steps in the recorded interval.
+    "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).
+    },
+  },
+  "swimLengthsData": { # Swim lengths data over the time interval. # Optional. Data for points in the `swim-lengths-data` 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).
+    },
+    "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.
+      "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).
+    },
+  },
+  "vo2Max": { # VO2 max measurement. # Optional. Data for points in the `vo2-max` sample data type collection.
+    "measurementMethod": "A String", # Optional. The method used to measure the VO2 max value.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which VO2 max 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).
+    },
+    "vo2Max": 3.14, # Required. VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+  },
+  "weight": { # Body weight measurement. # Optional. Data for points in the `weight` sample data type collection.
+    "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the weight 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).
+    },
+    "weightGrams": 3.14, # Required. Weight of a user in grams.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ dailyRollUp(parent, body=None, x__xgafv=None) +
Roll up data points over civil time intervals for supported data types.
+
+Args:
+  parent: string, Required. Parent data type of the Data Point collection. Format: `users/{user}/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/distance` For a list of the supported data types see the DailyRollupDataPoint value union field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to roll up data points by civil time intervals.
+  "dataSourceFamily": "A String", # Optional. The data source family name to roll up. If empty, data points from all available data sources will be rolled up. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/me/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/me/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect.
+  "pageSize": 42, # Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly.
+  "pageToken": "A String", # Optional. The `next_page_token` from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.
+  "range": { # Counterpart of google.type.Interval, but using CivilDateTime. # Required. Closed-open range of data points that will be rolled up. The start time must be aligned with the aggregation window. The maximum range for `calories-in-heart-rate-zone`, `heart-rate`, `active-minutes` and `total-calories` is 14 days. The maximum range for all other data types is 90 days.
+    "end": { # 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. # Required. The exclusive end of the range.
+      "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.
+      },
+    },
+    "start": { # 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. # Required. The inclusive start of the range.
+      "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.
+      },
+    },
+  },
+  "windowSizeDays": 42, # Optional. Aggregation window size, in number of days. Defaults to 1 if not specified. If the requested range is not an exact multiple of `window_size_days`, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than `window_size_days`.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response containing the list of rolled up data points.
+  "rollupDataPoints": [ # Values for each aggregation time window.
+    { # Value of a daily rollup for a single civil time interval (aggregation window) of reconciled data points from all data sources, excluding those data points that are identified as recorded by wearables in intervals when they were not actually worn.
+      "activeEnergyBurned": { # Represents the result of the rollup of active energy burned. # Returned by default when rolling up data points from the `active-energy-burned` data type.
+        "kcalSum": 3.14, # Output only. Sum of the active energy burned in kilocalories.
+      },
+      "activeMinutes": { # Represents the result of the rollup of the active minutes data type. # Returned by default when rolling up data points from the `active-minutes` data type, or when requested explicitly using the `active-minutes` rollup type identifier.
+        "activeMinutesRollupByActivityLevel": [ # Active minutes by activity level. At most one record per activity level is allowed.
+          { # Active minutes by activity level.
+            "activeMinutesSum": "A String", # Number of whole minutes spent in activity.
+            "activityLevel": "A String", # The level of activity.
+          },
+        ],
+      },
+      "activeZoneMinutes": { # Represents the result of the rollup of the active zone minutes data type. # Returned by default when rolling up data points from the `active-zone-minutes` data type, or when requested explicitly using the `active-zone-minutes` rollup type identifier.
+        "sumInCardioHeartZone": "A String", # Active zone minutes in `HeartRateZone.CARDIO`.
+        "sumInFatBurnHeartZone": "A String", # Active zone minutes in `HeartRateZone.FAT_BURN`.
+        "sumInPeakHeartZone": "A String", # Active zone minutes in `HeartRateZone.PEAK`.
+      },
+      "activityLevel": { # Represents the result of the rollup of the activity level data type. # Returned by default when rolling up data points from the `activity-level` data type, or when requested explicitly using the `activity-level` rollup type identifier.
+        "activityLevelRollupsByActivityLevelType": [ # List of total durations in each activity level type.
+          { # Represents the total duration in a specific activity level type.
+            "activityLevelType": "A String", # Activity level type.
+            "totalDuration": "A String", # Total duration in the activity level type.
+          },
+        ],
+      },
+      "altitude": { # Represents the result of the rollup of the user's altitude. # Returned by default when rolling up data points from the `altitude` data type, or when requested explicitly using the `altitude` rollup type identifier.
+        "gainMillimetersSum": "A String", # Sum of the altitude gain in millimeters.
+      },
+      "bloodGlucose": { # Represents the result of the rollup of the blood glucose data type. LINT: LEGACY_NAMES # Returned by default when rolling up data points from the `blood-glucose` data type.
+        "bloodGlucoseMilligramsPerDeciliterAvg": 3.14, # Average blood glucose level in mg/dL.
+      },
+      "bodyFat": { # Represents the result of the rollup of the body fat data type. # Returned by default when rolling up data points from the `body-fat` data type, or when requested explicitly using the `body-fat` rollup type identifier.
+        "bodyFatPercentageAvg": 3.14, # Average body fat percentage.
+      },
+      "caloriesInHeartRateZone": { # Represents the result of the rollup of the calories in heart rate zone data type. # Returned by default when rolling up data points from the `calories-in-heart-rate-zone` data type, or when requested explicitly using the `calories-in-heart-rate-zone` rollup type identifier.
+        "caloriesInHeartRateZones": [ # List of calories burned in each heart rate zone.
+          { # Represents the amount of kilocalories burned in a specific heart rate zone.
+            "heartRateZone": "A String", # The heart rate zone.
+            "kcal": 3.14, # The amount of kilocalories burned in the specified heart rate zone.
+          },
+        ],
+      },
+      "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. # End time of the window this value aggregates over
+        "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. # Start time of the window this value aggregates over
+        "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.
+        },
+      },
+      "coreBodyTemperature": { # Represents the result of the rollup of the core body temperature data type. # Returned by default when rolling up data points from the `core-body-temperature` data type, or when requested explicitly using the `core-body-temperature` rollup type identifier.
+        "temperatureCelsiusAvg": 3.14, # Average core body temperature in Celsius.
+        "temperatureCelsiusMax": 3.14, # Maximum core body temperature in Celsius.
+        "temperatureCelsiusMin": 3.14, # Minimum core body temperature in Celsius.
+      },
+      "distance": { # Result of the rollup of the user's distance. # Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier.
+        "millimetersSum": "A String", # Sum of the distance in millimeters.
+      },
+      "floors": { # Represents the result of the rollup of the user's floors. # Returned by default when rolling up data points from the `floors` data type, or when requested explicitly using the `floors` rollup type identifier.
+        "countSum": "A String", # Sum of the floors count.
+      },
+      "heartRate": { # Represents the result of the rollup of the heart rate data type. # Returned by default when rolling up data points from the `heart-rate` data type, or when requested explicitly using the `heart-rate` rollup type identifier.
+        "beatsPerMinuteAvg": 3.14, # The average heart rate value in the interval.
+        "beatsPerMinuteMax": 3.14, # The maximum heart rate value in the interval.
+        "beatsPerMinuteMin": 3.14, # The minimum heart rate value in the interval.
+      },
+      "heartRateVariabilityPersonalRange": { # Represents the result of the rollup of the user's daily heart rate variability personal range. # Returned by default when rolling up data points from the `daily-heart-rate-variability` data type, or when requested explicitly using the `heart-rate-variability-personal-range` rollup type identifier.
+        "averageHeartRateVariabilityMillisecondsMax": 3.14, # The upper bound of the user's average heart rate variability personal range.
+        "averageHeartRateVariabilityMillisecondsMin": 3.14, # The lower bound of the user's average heart rate variability personal range.
+      },
+      "hydrationLog": { # Represents the result of the rollup of the hydration log data type. # Returned by default when rolling up data points from the `hydration-log` data type, or when requested explicitly using the `hydration-log` rollup type identifier.
+        "amountConsumed": { # Rollup for volume quantity. # Rollup for amount consumed.
+          "millilitersSum": 3.14, # Required. The sum of volume in milliliters.
+          "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element.
+        },
+      },
+      "nutritionLog": { # Represents the result of the rollup of the nutrition log data type. # Returned by default when rolling up data points from the `nutrition-log` data type, or when requested explicitly using the `nutrition-log` rollup type identifier.
+        "energy": { # Rollup for the energy quantity. # Energy rollup.
+          "kcalSum": 3.14, # Required. The sum of the energy in kilocalories.
+          "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element.
+        },
+        "energyFromFat": { # Rollup for the energy quantity. # Value Energy from fat rollup.
+          "kcalSum": 3.14, # Required. The sum of the energy in kilocalories.
+          "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element.
+        },
+        "nutrients": [ # List of the nutrient roll-ups by the nutrient type.
+          { # Nutrient quantity rollup.
+            "nutrient": "A String", # Required. Aggregated nutrient.
+            "quantity": { # Rollup for the weight. # Required. Aggregated nutrient weight.
+              "gramsSum": 3.14, # Required. The sum of the weight in grams.
+              "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element.
+            },
+          },
+        ],
+        "totalCarbohydrate": { # Rollup for the weight. # Total carbohydrate rollup.
+          "gramsSum": 3.14, # Required. The sum of the weight in grams.
+          "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element.
+        },
+        "totalFat": { # Rollup for the weight. # Total fat rollup.
+          "gramsSum": 3.14, # Required. The sum of the weight in grams.
+          "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element.
+        },
+      },
+      "restingHeartRatePersonalRange": { # Represents the rollup value for the daily resting heart rate data type. # Returned by default when rolling up data points from the `daily-resting-heart-rate` data type, or when requested explicitly using the `resting-heart-rate-personal-range` rollup type identifier.
+        "beatsPerMinuteMax": 3.14, # The upper bound of the user's daily resting heart rate personal range.
+        "beatsPerMinuteMin": 3.14, # The lower bound of the user's daily resting heart rate personal range.
+      },
+      "runVo2Max": { # Represents the result of the rollup of the user's daily heart rate variability personal range. # Returned by default when rolling up data points from the `run-vo2-max` data type, or when requested explicitly using the `run-vo2-max` rollup type identifier.
+        "rateAvg": 3.14, # Average value of run VO2 max in the interval.
+        "rateMax": 3.14, # Maximum value of run VO2 max in the interval.
+        "rateMin": 3.14, # Minimum value of run VO2 max in the interval..
+      },
+      "sedentaryPeriod": { # Represents the result of the rollup of the user's sedentary periods. # Returned by default when rolling up data points from the `sedentary-period` data type, or when requested explicitly using the `sedentary-period` rollup type identifier.
+        "durationSum": "A String", # The total time user spent sedentary during the interval.
+      },
+      "steps": { # Represents the result of the rollup of the steps data type. # Returned by default when rolling up data points from the `steps` data type, or when requested explicitly using the `steps` rollup type identifier.
+        "countSum": "A String", # Total number of steps in the interval.
+      },
+      "swimLengthsData": { # Represents the result of the rollup of the swim lengths data type. # Returned by default when rolling up data points from the `swim-lengths-data` data type, or when requested explicitly using the `swim-lengths-data` rollup type identifier.
+        "strokeCountSum": "A String", # Total number of swim strokes in the interval.
+      },
+      "timeInHeartRateZone": { # Represents the result of the rollup of the time in heart rate zone data type. # Returned by default when rolling up data points from the `time-in-heart-rate-zone` data type, or when requested explicitly using the `time-in-heart-rate-zone` rollup type identifier.
+        "timeInHeartRateZones": [ # List of time spent in each heart rate zone.
+          { # Represents the total time spent in a specific heart rate zone.
+            "duration": "A String", # The total time spent in the specified heart rate zone.
+            "heartRateZone": "A String", # The heart rate zone.
+          },
+        ],
+      },
+      "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.
+        "weightGramsAvg": 3.14, # Average weight in grams.
+      },
+    },
+  ],
+}
+
+ +
+ exportExerciseTcx(name, partialData=None, x__xgafv=None) +
Exports exercise data in TCX format. **IMPORTANT:** HTTP clients must append `?alt=media` to the request URL to download the raw TCX file. Example: `https://health.googleapis.com/v4/users/me/dataTypes/exercise/dataPoints/EXERCISE_ID:exportExerciseTcx?alt=media` Without `alt=media`, the server returns a JSON response (`ExportExerciseTcxResponse`) which is intended primarily for gRPC clients. **Note:** While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.
+
+Args:
+  name: string, Required. The resource name of the exercise data point to export. Format: `users/{user}/dataTypes/exercise/dataPoints/{data_point}` Example: `users/me/dataTypes/exercise/dataPoints/2026443605080188808` The `{user}` is the alias `"me"` currently. Future versions may support user IDs. The `{data_point}` ID maps to the exercise ID, which is a long integer. (required)
+  partialData: boolean, Optional. Indicates whether to include the TCX data points when the GPS data is not available. If not specified, defaults to `false` and partial data will not be included.
+  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 for exporting exercise data in TCX format.
+  "tcxData": "A String", # Contains the exported TCX data. This field is intended for gRPC clients, as media download integration is not supported for gRPC. HTTP clients should instead use the `alt=media` query parameter to download the raw binary TCX file.
+}
+
+ +
+ exportExerciseTcx_media(name, partialData=None, x__xgafv=None) +
Exports exercise data in TCX format. **IMPORTANT:** HTTP clients must append `?alt=media` to the request URL to download the raw TCX file. Example: `https://health.googleapis.com/v4/users/me/dataTypes/exercise/dataPoints/EXERCISE_ID:exportExerciseTcx?alt=media` Without `alt=media`, the server returns a JSON response (`ExportExerciseTcxResponse`) which is intended primarily for gRPC clients. **Note:** While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.
+
+Args:
+  name: string, Required. The resource name of the exercise data point to export. Format: `users/{user}/dataTypes/exercise/dataPoints/{data_point}` Example: `users/me/dataTypes/exercise/dataPoints/2026443605080188808` The `{user}` is the alias `"me"` currently. Future versions may support user IDs. The `{data_point}` ID maps to the exercise ID, which is a long integer. (required)
+  partialData: boolean, Optional. Indicates whether to include the TCX data points when the GPS data is not available. If not specified, defaults to `false` and partial data will not be included.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  The media object as a string.
+
+    
+
+ +
+ get(name, x__xgafv=None) +
Get a single identifyable data point.
+
+Args:
+  name: string, Required. The name of the data point to retrieve. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` See DataPoint.name for examples and possible values. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A computed or recorded metric.
+  "activeEnergyBurned": { # Energy burned as part of an activity, excluding the basal energy burn. # Optional. Data for points in the `active-energy-burned` 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).
+    },
+    "kcal": 3.14, # Required. Energy burned during an activity, measured in kilocalories.
+  },
+  "activeMinutes": { # Record of active minutes in a given time interval. # Optional. Data for points in the `active-minutes` interval data type collection.
+    "activeMinutesByActivityLevel": [ # Required. Active minutes by activity level. At most one record per activity level is allowed.
+      { # Active minutes at a given activity level.
+        "activeMinutes": "A String", # Required. Number of whole minutes spent in activity.
+        "activityLevel": "A String", # Required. The level of activity.
+      },
+    ],
+    "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).
+    },
+  },
+  "activeZoneMinutes": { # Record of active zone minutes in a given time interval. # Optional. Data for points in the `active-zone-minutes` interval data type collection, measured in minutes.
+    "activeZoneMinutes": "A String", # Required. Number of Active Zone Minutes earned in the given time interval. Note: active_zone_minutes equals to 1 for low intensity (fat burn) zones or 2 for high intensity zones (cardio, peak).
+    "heartRateZone": "A String", # Required. Heart rate zone in which the active zone minutes have been earned, in the given time interval.
+    "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).
+    },
+  },
+  "activityLevel": { # Internal type to capture activity level during a certain time interval. # Optional. Data for points in the `activity-level` daily data type collection.
+    "activityLevelType": "A String", # Required. Activity level type in the given time interval.
+    "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).
+    },
+  },
+  "altitude": { # Captures the altitude gain (i.e. deltas), and not level above sea, for a user in millimeters. # Optional. Data for points in the `altitude` interval data type collection.
+    "gainMillimeters": "A String", # Required. Altitude gain in millimeters over the observed interval.
+    "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).
+    },
+  },
+  "basalEnergyBurned": { # Number of calories burned due to basal metabolic rate (BMR) over a period of time. # Optional. Data for points in the `basal-energy-burned` 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).
+    },
+    "kcal": 3.14, # Required. Number of calories burned due to basal metabolic rate in kilocalories over the observed interval.
+  },
+  "bloodGlucose": { # Represents a blood glucose level measurement. LINT: LEGACY_NAMES # Optional. Data for points in the `blood-glucose` sample data type collection.
+    "bloodGlucoseMilligramsPerDeciliter": 3.14, # Required. Blood glucose level concentration in mg/dL.
+    "mealType": "A String", # Optional. Meal type of the measurement.
+    "measurementSource": "A String", # Optional. Source of the measurement.
+    "measurementTiming": "A String", # Optional. Timing of the measurement.
+    "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which blood glucose 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).
+    },
+    "specimen": "A String", # Optional. Type of body fluid used to measure the blood glucose.
+  },
+  "bodyFat": { # Body fat measurement. # Optional. Data for points in the `body-fat` sample data type collection.
+    "percentage": 3.14, # Required. Body fat percentage, in range [0, 100].
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which body fat 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).
+    },
+  },
+  "coreBodyTemperature": { # Core body temperature measurement, distinct from peripheral body temperature, reflects the temperature of the body's internal organs. # Optional. Data for points in the `core-body-temperature` sample data type collection.
+    "id": "A String", # Optional. The unique identifier of the core body temperature measurement.
+    "measurementLocation": "A String", # Optional. The location of the core body temperature measurement.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which core body temperature 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).
+    },
+    "temperatureCelsius": 3.14, # Required. The core body temperature in Celsius.
+  },
+  "dailyHeartRateVariability": { # Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds` # Optional. Data for points in the `daily-heart-rate-variability` daily data type collection.
+    "averageHeartRateVariabilityMilliseconds": 3.14, # Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats.
+    "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. Date (in the user's timezone) of heart rate variability measurement.
+      "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.
+    },
+    "deepSleepRootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences (RMSSD) value during deep sleep.
+    "entropy": 3.14, # Optional. The Shanon entropy of heartbeat intervals. Entropy quantifies randomness or disorder in a system. High entropy indicates high HRV. Entropy is measured from the histogram of time interval between successive heart beats values measured during sleep.
+    "nonRemHeartRateBeatsPerMinute": "A String", # Optional. Non-REM heart rate
+  },
+  "dailyHeartRateZones": { # User's heart rate zone thresholds based on the Karvonen algorithm for a specific day. # Optional. Data for points in the `daily-heart-rate-zones` daily data type collection.
+    "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. Date (in user's timezone) of the heart rate zones record.
+      "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.
+    },
+    "heartRateZones": [ # Required. The heart rate zones.
+      { # The heart rate zone.
+        "heartRateZoneType": "A String", # Required. The heart rate zone type.
+        "maxBeatsPerMinute": "A String", # Required. Maximum heart rate for this zone in beats per minute.
+        "minBeatsPerMinute": "A String", # Required. Minimum heart rate for this zone in beats per minute.
+      },
+    ],
+  },
+  "dailyOxygenSaturation": { # A daily oxygen saturation (SpO2) record. Represents the user's daily oxygen saturation summary, typically calculated during sleep. # Optional. Data for points in the `daily-oxygen-saturation` daily data type collection.
+    "averagePercentage": 3.14, # Required. The average value of the oxygen saturation samples during the sleep.
+    "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. Date (in user's timezone) of the daily oxygen saturation record.
+      "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.
+    },
+    "lowerBoundPercentage": 3.14, # Required. The lower bound of the confidence interval of oxygen saturation samples during sleep.
+    "standardDeviationPercentage": 3.14, # Optional. Standard deviation of the daily oxygen saturation averages from the past 7-30 days.
+    "upperBoundPercentage": 3.14, # Required. The upper bound of the confidence interval of oxygen saturation samples during sleep.
+  },
+  "dailyRespiratoryRate": { # A daily average respiratory rate (breaths per minute) for a day of the year. One data point per day calculated for the main sleep. # Optional. Data for points in the `daily-respiratory-rate` daily data type collection.
+    "breathsPerMinute": 3.14, # Required. The average number of breaths taken per minute.
+    "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. The date on which the respiratory rate was measured.
+      "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.
+    },
+  },
+  "dailyRestingHeartRate": { # Measures the daily resting heart rate for a user, calculated using the all day heart rate measurements. # Optional. Data for points in the `daily-resting-heart-rate` daily data type collection.
+    "beatsPerMinute": "A String", # Required. The resting heart rate value in beats per minute.
+    "dailyRestingHeartRateMetadata": { # Metadata for the daily resting heart rate. # Optional. Metadata for the daily resting heart rate.
+      "calculationMethod": "A String", # Required. The method used to calculate the resting heart rate.
+    },
+    "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. Date (in the user's timezone) of the resting heart rate measurement.
+      "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.
+    },
+  },
+  "dailySleepTemperatureDerivations": { # Provides derived sleep temperature values, calculated from skin or internal device temperature readings during sleep. # Optional. Data for points in the `daily-sleep-temperature-derivations` daily data type collection.
+    "baselineTemperatureCelsius": 3.14, # Optional. The user's baseline skin temperature. It is the median of the user's nightly skin temperature over the past 30 days.
+    "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. Date for which the sleep temperature derivations are calculated.
+      "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.
+    },
+    "nightlyTemperatureCelsius": 3.14, # Required. The user's nightly skin temperature. It is the mean of skin temperature samples taken from the user’s sleep.
+    "relativeNightlyStddev30dCelsius": 3.14, # Optional. The standard deviation of the user’s relative nightly skin temperature (temperature - baseline) over the past 30 days.
+  },
+  "dailyVo2Max": { # Contains a daily summary of the user's VO2 max (cardio fitness score), which is the maximum rate of oxygen the body can use during exercise. # Optional. Data for points in the `daily-vo2-max` daily data type collection.
+    "cardioFitnessLevel": "A String", # Optional. Represents the user's cardio fitness level based on their VO2 max.
+    "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. The date for which the Daily VO2 max was measured.
+      "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.
+    },
+    "estimated": True or False, # Optional. An estimated field is added to indicate when the confidence has decreased sufficiently to consider the value an estimation.
+    "vo2Max": 3.14, # Required. Daily VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+    "vo2MaxCovariance": 3.14, # Optional. The covariance of the VO2 max value.
+  },
+  "dataSource": { # Data Source definition to track the origin of data. Each health data point, regardless of the complexity or data model (whether a simple step count or a detailed sleep session) must retain information about its source of origin (e.g. the device or app that collected it). # Optional. Data source information for the metric
+    "application": { # Optional metadata for the application that provided this data. # Output only. Captures metadata for the application that provided this data.
+      "googleWebClientId": "A String", # Output only. The Google OAuth 2.0 client ID of the web application or service that recorded the data. This is the client ID used during the Google OAuth flow to obtain user credentials. This field is system-populated when the data is uploaded from Google Web API.
+      "packageName": "A String", # Output only. A unique identifier for the mobile application that was the source of the data. This is typically the application's package name on Android (e.g., `com.google.fitbit`) or the bundle ID on iOS. This field is informational and helps trace data origin. This field is system-populated when the data is uploaded from the Fitbit mobile application, Health Connect or Health Kit.
+      "webClientId": "A String", # Output only. The client ID of the application that recorded the data. This ID is a legacy Fitbit API client ID, which is different from a Google OAuth client ID. Example format: `ABC123`. This field is system-populated and used for tracing data from legacy Fitbit API integrations. This field is system-populated when the data is uploaded from a legacy Fitbit API integration.
+    },
+    "device": { # Captures metadata about the device that recorded the measurement. # Optional. Captures metadata for raw data points originating from devices. We expect this data source to be used for data points written on device sync.
+      "displayName": "A String", # Optional. An optional name for the device.
+      "formFactor": "A String", # Optional. Captures the form factor of the device.
+      "manufacturer": "A String", # Optional. An optional manufacturer of the device.
+    },
+    "platform": "A String", # Output only. Captures the platform that uploaded the data.
+    "recordingMethod": "A String", # Optional. Captures how the data was recorded.
+  },
+  "distance": { # Distance traveled over an interval of time. # Optional. Data for points in the `distance` 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).
+    },
+    "millimeters": "A String", # Required. Distance in millimeters over the observed interval.
+  },
+  "electrocardiogram": { # Represents an Electrocardiogram (ECG) measurement session. This data type is based on SaMD feature and any changes to it may require additional review. # Optional. Data for points in the `electrocardiogram` session data type collection.
+    "beatsPerMinuteAvg": "A String", # Optional. Average heart rate recorded during ECG reading in beats per minute.
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. NOTE: Historical ECG data lacks timezone offsets, so `start_utc_offset` and `end_utc_offset` will be missing or default to zero. As a result, the civil time fields within this interval will default to UTC. It is recommended to use physical time fields instead for accurate time referencing. NOTE: The `start_time` and `end_time` of the interval are equal, representing the reading time.
+      "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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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).
+    },
+    "leadNumber": 42, # Optional. The number of leads used for ECG reading.
+    "medicalDeviceInfo": { # Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI). # Output only. The meta information for the compatible device used to conduct the measurement. ECG measurements typically populate `firmware_version`, `feature_version`, and `device_model`.
+      "algorithmVersion": "A String", # Output only. The algorithm version used by the feature.
+      "deviceModel": "A String", # Output only. The model name or device type of the compatible device used to collect the data.
+      "featureVersion": "A String", # Output only. The version of the feature/app running on the device.
+      "firmwareVersion": "A String", # Output only. The firmware version running on the compatible device used to collect the data.
+      "serviceVersion": "A String", # Output only. The service version used by the feature.
+    },
+    "millivoltsScalingFactor": 42, # Optional. The factor by which to divide waveform samples to get voltage in millivolts: millivolts = waveform_sample / millivolts_scaling_factor.
+    "resultClassification": "A String", # Optional. The result classification of the ECG reading.
+    "samplingFrequencyHertz": 42, # Optional. The sampling frequency of waveform samples in hertz.
+    "waveformSamples": [ # Optional. An array of voltage values representing lead I ECG values. Each sample represents voltage difference in ECG graph. The first value in array corresponds to the start of the reading.
+      42,
+    ],
+  },
+  "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. 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
+        "eventUtcOffset": "A String", # Required. Exercise event time offset from UTC
+        "exerciseEventType": "A String", # Required. The type of the event, such as start, stop, pause, resume.
+      },
+    ],
+    "exerciseMetadata": { # Additional exercise metadata. # Optional. Additional exercise metadata.
+      "hasGps": True or False, # Optional. Whether the exercise had GPS tracking.
+      "poolLengthMillimeters": "A String", # Optional. Pool length in millimeters. Only present in the swimming exercises.
+    },
+    "exerciseType": "A String", # Required. The type of activity performed during an exercise.
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed exercise 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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).
+    },
+    "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this exercise ( )
+      "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+      "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+      "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+      "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+      "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+      "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+      "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+      "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+        "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+        "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+        "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+        "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+      },
+      "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+        "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+        "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+        "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+        "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+        "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+      },
+      "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+      "steps": "A String", # Optional. Total steps taken during the exercise.
+      "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+    },
+    "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+    "splitSummaries": [ # Optional. Laps or splits recorded within an exercise. Laps could be split based on distance or other criteria (duration, etc.) Laps should not be overlapping with each other.
+      { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+        "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+        "endTime": "A String", # Required. Lap end time
+        "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+        "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+          "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+          "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+          "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+          "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+          "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+          "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+          "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+          "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+            "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+            "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+            "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+            "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+          },
+          "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+            "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+            "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+            "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+            "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+            "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+          },
+          "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+          "steps": "A String", # Optional. Total steps taken during the exercise.
+          "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+        },
+        "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+        "startTime": "A String", # Required. Lap start time
+        "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+      },
+    ],
+    "splits": [ # Optional. The default split is 1 km or 1 mile. - if the movement distance is less than the default, then there are no splits - if the movement distance is greater than or equal to the default, then we have splits
+      { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+        "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+        "endTime": "A String", # Required. Lap end time
+        "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+        "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+          "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+          "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+          "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+          "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+          "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+          "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+          "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+          "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+            "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+            "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+            "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+            "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+          },
+          "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+            "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+            "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+            "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+            "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+            "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+          },
+          "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+          "steps": "A String", # Optional. Total steps taken during the exercise.
+          "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+        },
+        "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+        "startTime": "A String", # Required. Lap start time
+        "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+      },
+    ],
+    "updateTime": "A String", # Output only. This is the timestamp of the last update to the exercise.
+  },
+  "floors": { # Gained elevation measured in floors over the time interval # Optional. Data for points in the `floors` interval data type collection.
+    "count": "A String", # Required. Number of floors in the recorded interval
+    "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).
+    },
+  },
+  "food": { # Represents a food item. # Optional. The food details.
+    "accessLevel": "A String", # Required. The access level of the food.
+    "brand": "A String", # Optional. The brand of the food.
+    "defaultServing": { # Represents different properties and information about the serving of a specific food. # Required. Value representing the default serving of the food.
+      "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported.
+      "foodMeasurementUnit": "A String", # Required. Food measurement unit
+      "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram").
+      "foodMeasurementUnitDisplayNamePlural": "A String", # Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams").
+      "multiplier": 3.14, # Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving.
+    },
+    "description": "A String", # Optional. The description of the food.
+    "displayName": "A String", # Required. The display name of the food.
+    "energyAvg": { # Represents the energy quantity. # Optional. Value representing the average energy of the food for the default serving.
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the food for the default serving.
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "energyMax": { # Represents the energy quantity. # Optional. Value representing the maximum energy of the food for the default serving.
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "energyMin": { # Represents the energy quantity. # Optional. Value representing the minimum energy of the food for the default serving.
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "languageCode": "A String", # Optional. The language code where the food is available in format xx-XX. Supported values are defined in Settings.food_language_code.
+    "mealType": "A String", # Optional. The meal type associated with this food.
+    "nutrients": [ # Optional. Value representing the nutrients of the food for the default serving.
+      { # Represents the quantity of a nutrient.
+        "nutrient": "A String", # Required. The nutrient type.
+        "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams.
+          "grams": 3.14, # Required. The weight value in grams.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+      },
+    ],
+    "servings": [ # Optional. The serving of the food.
+      { # Represents different properties and information about the serving of a specific food.
+        "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported.
+        "foodMeasurementUnit": "A String", # Required. Food measurement unit
+        "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram").
+        "foodMeasurementUnitDisplayNamePlural": "A String", # Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams").
+        "multiplier": 3.14, # Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving.
+      },
+    ],
+    "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the food for the default serving.
+      "grams": 3.14, # Required. The weight value in grams.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the food for the default serving.
+      "grams": 3.14, # Required. The weight value in grams.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+  },
+  "foodMeasurementUnit": { # Represents a food measurement unit. # Optional. The food measurement unit details.
+    "displayName": "A String", # Required. The display name of the food measurement unit (e.g., "gram", "piece").
+    "pluralDisplayName": "A String", # Optional. The plural display name of the food measurement unit (e.g., "grams", "pieces").
+  },
+  "heartRate": { # A heart rate measurement. # Optional. Data for points in the `heart-rate` sample data type collection.
+    "beatsPerMinute": "A String", # Required. The heart rate value in beats per minute.
+    "metadata": { # Heart rate metadata. # Optional. Metadata about the heart rate sample.
+      "motionContext": "A String", # Optional. Indicates the user’s level of activity when the heart rate sample was measured
+      "sensorLocation": "A String", # Optional. Indicates the location of the sensor that measured the heart rate.
+    },
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. Observation time
+      "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).
+    },
+  },
+  "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection.
+    "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces.
+      "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz).
+      "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz).
+    },
+    "rootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time of the heart rate variability measurement.
+      "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).
+    },
+    "standardDeviationMilliseconds": 3.14, # Optional. The standard deviation of the heart rate variability measurement.
+  },
+  "height": { # Body height measurement. # Optional. Data for points in the `height` sample data type collection.
+    "heightMillimeters": "A String", # Required. Height of the user in millimeters.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the height was recorded.
+      "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).
+    },
+  },
+  "hydrationLog": { # Holds information about a user logged hydration. # Optional. Data for points in the `hydration-log` session data type collection.
+    "amountConsumed": { # Represents the volume quantity. # Required. Amount of liquid (ex. water) consumed.
+      "milliliters": 3.14, # Required. Value representing the volume in milliliters.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit, used only for user-facing input and display purposes. In the API format, all volume quantities are converted to milliliters.
+    },
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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).
+    },
+  },
+  "irregularRhythmNotification": { # Represents an Irregular Rhythm Notification alert, indicating a potential sign of atrial fibrillation (AFib). This data type is based on SaMD feature and any changes to it may require additional review. # Optional. Data for points in the `irregular-rhythm-notification` session data type collection.
+    "alertWindows": [ # Optional. The overlapping analysis windows that were used to evaluate rhythm for potential AFib, containing specific information about the user's heart rhythm.
+      { # An analysis window evaluated for AFib. Note: The current version of the algorithm will only produce alerts if all windows are positive. So anything returned from the API will always have the positive bit set to true. Internally, windows can be negative, however. We never save "inconclusive" windows (they aren't produced by the algorithm).
+        "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. The end time of the analysis window.
+        "endUtcOffset": "A String", # Required. The UTC offset of the user's timezone when the analysis window ended.
+        "heartBeats": [ # Optional. All heart beats in the interval contained in this analysis window.
+          { # A single heart beat measurement.
+            "beatsPerMinute": 42, # Required. The beats-per-minute value extrapolated from the time before the following heart beat. This is calculated as 60000 / rr, where rr is the gap between heart beats in milliseconds (IBI - Interbeat Interval).
+            "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 heart beat measurement.
+            "utcOffset": "A String", # Required. The UTC offset of the user's timezone when the heart beat measurement occurred.
+          },
+        ],
+        "positive": True or False, # Optional. Flag indicating whether the window was positive for AFib or not. A `true` value indicates that AFib was detected in this window. A `false` value means AFib was not detected, but does not guarantee the absence of AFib.
+        "startTime": "A String", # Required. Observed interval. The start time of the analysis window.
+        "startUtcOffset": "A String", # Required. The UTC offset of the user's timezone when the analysis window started.
+      },
+    ],
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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).
+    },
+    "medicalDeviceInfo": { # Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI). # Output only. The meta information for the compatible device used to conduct the measurement. Irregular Rhythm Notification measurements typically populate `algorithm_version`, `service_version`, and `device_model`.
+      "algorithmVersion": "A String", # Output only. The algorithm version used by the feature.
+      "deviceModel": "A String", # Output only. The model name or device type of the compatible device used to collect the data.
+      "featureVersion": "A String", # Output only. The version of the feature/app running on the device.
+      "firmwareVersion": "A String", # Output only. The firmware version running on the compatible device used to collect the data.
+      "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`).
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "energyFromFat": { # Represents the energy quantity. # Optional. The energy from fat, measured in kilocalories (`kcal`).
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "food": "A String", # Optional. The resource name of the Food item. Required when creating a nutrition log from an identified food. For anonymous food logs, use the `food_display_name` field instead.
+    "foodDisplayName": "A String", # The display name of the food. For identified food logs, this is populated automatically from the referenced food.
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. The time window when the food was logged.
+      "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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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).
+    },
+    "mealType": "A String", # Optional. The meal category. One of `BREAKFAST`, `LUNCH`, `DINNER`, or `SNACK`.
+    "nutrients": [ # Optional. An array of individual nutrient values for the nutrition log.
+      { # Represents the quantity of a nutrient.
+        "nutrient": "A String", # Required. The nutrient type.
+        "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams.
+          "grams": 3.14, # Required. The weight value in grams.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+      },
+    ],
+    "serving": { # Represents different properties and information about the serving of a specific food. # Optional. The serving information for the logged food.
+      "amount": 3.14, # Optional. The number of servings.
+      "foodMeasurementUnit": "A String", # Required. Food measurement unit
+      "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram").
+    },
+    "totalCarbohydrate": { # Represents the weight quantity. # Optional. The total carbohydrate content, measured in grams.
+      "grams": 3.14, # Required. The weight value in grams.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "totalFat": { # Represents the weight quantity. # Optional. The total fat content, measured in grams.
+      "grams": 3.14, # Required. The weight value in grams.
+      "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.
+      "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).
+    },
+  },
+  "respiratoryRateSleepSummary": { # Records respiratory rate details during sleep. Can have multiple per day if the user sleeps multiple times. # Optional. Data for points in the `respiratory-rate-sleep-summary` sample data type collection.
+    "deepSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for deep sleep.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "fullSleepStats": { # Respiratory rate statistics for a given sleep stage. # Required. Full respiratory rate statistics.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "lightSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for light sleep.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "remSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for REM sleep.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which respiratory rate 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).
+    },
+  },
+  "runVo2Max": { # VO2 max value calculated based on the user's running activity. Value stored in ml/kg/min. # Optional. Data for points in the `run-vo2-max` sample data type collection.
+    "runVo2Max": 3.14, # Required. Run VO2 max value in ml/kg/min.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the metric 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).
+    },
+  },
+  "sedentaryPeriod": { # SedentaryPeriod SedentaryPeriod data represents the periods of time that the user was sedentary (i.e. not moving while wearing the device). # Optional. Data for points in the `sedentary-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).
+    },
+  },
+  "sleep": { # A sleep session possibly including stages. # Optional. Data for points in the `sleep` session data type collection.
+    "createTime": "A String", # Output only. Creation time of this sleep observation.
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed sleep 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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: `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.
+      "stagesStatus": "A String", # Output only. Sleep stages algorithm processing status.
+    },
+    "outOfBedSegments": [ # Optional. “Out of bed” segments that can overlap with sleep stages.
+      { # A time interval to represent an out-of-bed segment.
+        "endTime": "A String", # Required. Segment end time.
+        "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the segment relative to the Coordinated Universal Time (UTC).
+        "startTime": "A String", # Required. Segment tart time.
+        "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the segment relative to the Coordinated Universal Time (UTC).
+      },
+    ],
+    "shortAwakenings": [ # Output only. List of short awake segments (under a set threshold) that are part of the sleep session. These can overlap with sleep stages.
+      { # Sleep stage segment.
+        "createTime": "A String", # Output only. Creation time of this sleep stages segment.
+        "endTime": "A String", # Required. Sleep stage end time.
+        "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC).
+        "startTime": "A String", # Required. Sleep stage start time.
+        "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC).
+        "type": "A String", # Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+        "updateTime": "A String", # Output only. Last update time of this sleep stages segment.
+      },
+    ],
+    "stages": [ # Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.
+      { # Sleep stage segment.
+        "createTime": "A String", # Output only. Creation time of this sleep stages segment.
+        "endTime": "A String", # Required. Sleep stage end time.
+        "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC).
+        "startTime": "A String", # Required. Sleep stage start time.
+        "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC).
+        "type": "A String", # Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+        "updateTime": "A String", # Output only. Last update time of this sleep stages segment.
+      },
+    ],
+    "summary": { #  Sleep summary: metrics and stages summary. # Output only. Sleep summary: metrics and stages summary.
+      "minutesAfterWakeUp": "A String", # Output only. Minutes after wake up calculated by restlessness algorithm.
+      "minutesAsleep": "A String", # Output only. Total number of minutes asleep. For classic sleep it is the sum of ASLEEP stages (excluding AWAKE and RESTLESS). For "stages" sleep it is the sum of LIGHT, REM and DEEP stages (excluding AWAKE).
+      "minutesAwake": "A String", # Output only. Total number of minutes awake. It is a sum of all AWAKE stages.
+      "minutesInSleepPeriod": "A String", # Output only. Delta between wake time and bedtime. It is the sum of all stages.
+      "minutesToFallAsleep": "A String", # Output only. Minutes to fall asleep calculated by restlessness algorithm.
+      "stagesSummary": [ # Output only. List of summaries (total duration and segment count) per each sleep stage type.
+        { # Total duration and segment count for a stage.
+          "count": "A String", # Output only. Number of sleep stages segments.
+          "minutes": "A String", # Output only. Total duration in minutes of a sleep stage.
+          "type": "A String", # Output only. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+        },
+      ],
+    },
+    "type": "A String", # Optional. SleepType: classic or stages.
+    "updateTime": "A String", # Output only. Last update time of this sleep observation.
+  },
+  "steps": { # Step count over the time interval. # Optional. Data for points in the `steps` interval data type collection.
+    "count": "A String", # Required. Number of steps in the recorded interval.
+    "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).
+    },
+  },
+  "swimLengthsData": { # Swim lengths data over the time interval. # Optional. Data for points in the `swim-lengths-data` 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).
+    },
+    "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.
+      "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).
+    },
+  },
+  "vo2Max": { # VO2 max measurement. # Optional. Data for points in the `vo2-max` sample data type collection.
+    "measurementMethod": "A String", # Optional. The method used to measure the VO2 max value.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which VO2 max 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).
+    },
+    "vo2Max": 3.14, # Required. VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+  },
+  "weight": { # Body weight measurement. # Optional. Data for points in the `weight` sample data type collection.
+    "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the weight 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).
+    },
+    "weightGrams": 3.14, # Required. Weight of a user in grams.
+  },
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Query user health and fitness data points.
+
+Args:
+  parent: string, Required. Parent data type of the Data Point collection. Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/weight` For a list of the supported data types see the DataPoint data union field. (required)
+  filter: string, Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"` - `distance.interval.start_time >= "2024-08-14T12:34:56Z"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time >= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"` - `distance.interval.civil_start_time >= "2024-08-14T12:34:56"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"` - `weight.sample_time.physical_time >= "2024-08-14T12:34:56Z"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time >= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"` - `weight.sample_time.civil_time >= "2024-08-14T12:34:56"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < "2024-08-15"` - Session civil start time (**Excluding Sleep and ECG**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time >= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"` - `exercise.interval.civil_start_time >= "2024-08-14T12:34:56"` - Session start time (**ECG specific**): - Pattern: `electrocardiogram.interval.start_time` - Supported comparison operators: `>=` - Timestamp literal expected in RFC-3339 format - Example: - `electrocardiogram.interval.start_time >= "2024-08-14T12:34:56Z"` - Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., `electrocardiogram.interval.end_time`) is not supported. - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time >= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"` Data points in the response will be ordered by the interval start time in descending order.
+  pageSize: integer, Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25.
+  pageToken: string, Optional. The `next_page_token` from a previous 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 containing raw data points matching the query
+  "dataPoints": [ # Data points matching the query
+    { # A computed or recorded metric.
+      "activeEnergyBurned": { # Energy burned as part of an activity, excluding the basal energy burn. # Optional. Data for points in the `active-energy-burned` 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).
+        },
+        "kcal": 3.14, # Required. Energy burned during an activity, measured in kilocalories.
+      },
+      "activeMinutes": { # Record of active minutes in a given time interval. # Optional. Data for points in the `active-minutes` interval data type collection.
+        "activeMinutesByActivityLevel": [ # Required. Active minutes by activity level. At most one record per activity level is allowed.
+          { # Active minutes at a given activity level.
+            "activeMinutes": "A String", # Required. Number of whole minutes spent in activity.
+            "activityLevel": "A String", # Required. The level of activity.
+          },
+        ],
+        "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).
+        },
+      },
+      "activeZoneMinutes": { # Record of active zone minutes in a given time interval. # Optional. Data for points in the `active-zone-minutes` interval data type collection, measured in minutes.
+        "activeZoneMinutes": "A String", # Required. Number of Active Zone Minutes earned in the given time interval. Note: active_zone_minutes equals to 1 for low intensity (fat burn) zones or 2 for high intensity zones (cardio, peak).
+        "heartRateZone": "A String", # Required. Heart rate zone in which the active zone minutes have been earned, in the given time interval.
+        "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).
+        },
+      },
+      "activityLevel": { # Internal type to capture activity level during a certain time interval. # Optional. Data for points in the `activity-level` daily data type collection.
+        "activityLevelType": "A String", # Required. Activity level type in the given time interval.
+        "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).
+        },
+      },
+      "altitude": { # Captures the altitude gain (i.e. deltas), and not level above sea, for a user in millimeters. # Optional. Data for points in the `altitude` interval data type collection.
+        "gainMillimeters": "A String", # Required. Altitude gain in millimeters over the observed interval.
+        "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).
+        },
+      },
+      "basalEnergyBurned": { # Number of calories burned due to basal metabolic rate (BMR) over a period of time. # Optional. Data for points in the `basal-energy-burned` 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).
+        },
+        "kcal": 3.14, # Required. Number of calories burned due to basal metabolic rate in kilocalories over the observed interval.
+      },
+      "bloodGlucose": { # Represents a blood glucose level measurement. LINT: LEGACY_NAMES # Optional. Data for points in the `blood-glucose` sample data type collection.
+        "bloodGlucoseMilligramsPerDeciliter": 3.14, # Required. Blood glucose level concentration in mg/dL.
+        "mealType": "A String", # Optional. Meal type of the measurement.
+        "measurementSource": "A String", # Optional. Source of the measurement.
+        "measurementTiming": "A String", # Optional. Timing of the measurement.
+        "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which blood glucose 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).
+        },
+        "specimen": "A String", # Optional. Type of body fluid used to measure the blood glucose.
+      },
+      "bodyFat": { # Body fat measurement. # Optional. Data for points in the `body-fat` sample data type collection.
+        "percentage": 3.14, # Required. Body fat percentage, in range [0, 100].
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which body fat 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).
+        },
+      },
+      "coreBodyTemperature": { # Core body temperature measurement, distinct from peripheral body temperature, reflects the temperature of the body's internal organs. # Optional. Data for points in the `core-body-temperature` sample data type collection.
+        "id": "A String", # Optional. The unique identifier of the core body temperature measurement.
+        "measurementLocation": "A String", # Optional. The location of the core body temperature measurement.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which core body temperature 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).
+        },
+        "temperatureCelsius": 3.14, # Required. The core body temperature in Celsius.
+      },
+      "dailyHeartRateVariability": { # Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds` # Optional. Data for points in the `daily-heart-rate-variability` daily data type collection.
+        "averageHeartRateVariabilityMilliseconds": 3.14, # Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats.
+        "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. Date (in the user's timezone) of heart rate variability measurement.
+          "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.
+        },
+        "deepSleepRootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences (RMSSD) value during deep sleep.
+        "entropy": 3.14, # Optional. The Shanon entropy of heartbeat intervals. Entropy quantifies randomness or disorder in a system. High entropy indicates high HRV. Entropy is measured from the histogram of time interval between successive heart beats values measured during sleep.
+        "nonRemHeartRateBeatsPerMinute": "A String", # Optional. Non-REM heart rate
+      },
+      "dailyHeartRateZones": { # User's heart rate zone thresholds based on the Karvonen algorithm for a specific day. # Optional. Data for points in the `daily-heart-rate-zones` daily data type collection.
+        "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. Date (in user's timezone) of the heart rate zones record.
+          "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.
+        },
+        "heartRateZones": [ # Required. The heart rate zones.
+          { # The heart rate zone.
+            "heartRateZoneType": "A String", # Required. The heart rate zone type.
+            "maxBeatsPerMinute": "A String", # Required. Maximum heart rate for this zone in beats per minute.
+            "minBeatsPerMinute": "A String", # Required. Minimum heart rate for this zone in beats per minute.
+          },
+        ],
+      },
+      "dailyOxygenSaturation": { # A daily oxygen saturation (SpO2) record. Represents the user's daily oxygen saturation summary, typically calculated during sleep. # Optional. Data for points in the `daily-oxygen-saturation` daily data type collection.
+        "averagePercentage": 3.14, # Required. The average value of the oxygen saturation samples during the sleep.
+        "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. Date (in user's timezone) of the daily oxygen saturation record.
+          "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.
+        },
+        "lowerBoundPercentage": 3.14, # Required. The lower bound of the confidence interval of oxygen saturation samples during sleep.
+        "standardDeviationPercentage": 3.14, # Optional. Standard deviation of the daily oxygen saturation averages from the past 7-30 days.
+        "upperBoundPercentage": 3.14, # Required. The upper bound of the confidence interval of oxygen saturation samples during sleep.
+      },
+      "dailyRespiratoryRate": { # A daily average respiratory rate (breaths per minute) for a day of the year. One data point per day calculated for the main sleep. # Optional. Data for points in the `daily-respiratory-rate` daily data type collection.
+        "breathsPerMinute": 3.14, # Required. The average number of breaths taken per minute.
+        "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. The date on which the respiratory rate was measured.
+          "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.
+        },
+      },
+      "dailyRestingHeartRate": { # Measures the daily resting heart rate for a user, calculated using the all day heart rate measurements. # Optional. Data for points in the `daily-resting-heart-rate` daily data type collection.
+        "beatsPerMinute": "A String", # Required. The resting heart rate value in beats per minute.
+        "dailyRestingHeartRateMetadata": { # Metadata for the daily resting heart rate. # Optional. Metadata for the daily resting heart rate.
+          "calculationMethod": "A String", # Required. The method used to calculate the resting heart rate.
+        },
+        "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. Date (in the user's timezone) of the resting heart rate measurement.
+          "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.
+        },
+      },
+      "dailySleepTemperatureDerivations": { # Provides derived sleep temperature values, calculated from skin or internal device temperature readings during sleep. # Optional. Data for points in the `daily-sleep-temperature-derivations` daily data type collection.
+        "baselineTemperatureCelsius": 3.14, # Optional. The user's baseline skin temperature. It is the median of the user's nightly skin temperature over the past 30 days.
+        "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. Date for which the sleep temperature derivations are calculated.
+          "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.
+        },
+        "nightlyTemperatureCelsius": 3.14, # Required. The user's nightly skin temperature. It is the mean of skin temperature samples taken from the user’s sleep.
+        "relativeNightlyStddev30dCelsius": 3.14, # Optional. The standard deviation of the user’s relative nightly skin temperature (temperature - baseline) over the past 30 days.
+      },
+      "dailyVo2Max": { # Contains a daily summary of the user's VO2 max (cardio fitness score), which is the maximum rate of oxygen the body can use during exercise. # Optional. Data for points in the `daily-vo2-max` daily data type collection.
+        "cardioFitnessLevel": "A String", # Optional. Represents the user's cardio fitness level based on their VO2 max.
+        "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. The date for which the Daily VO2 max was measured.
+          "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.
+        },
+        "estimated": True or False, # Optional. An estimated field is added to indicate when the confidence has decreased sufficiently to consider the value an estimation.
+        "vo2Max": 3.14, # Required. Daily VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+        "vo2MaxCovariance": 3.14, # Optional. The covariance of the VO2 max value.
+      },
+      "dataSource": { # Data Source definition to track the origin of data. Each health data point, regardless of the complexity or data model (whether a simple step count or a detailed sleep session) must retain information about its source of origin (e.g. the device or app that collected it). # Optional. Data source information for the metric
+        "application": { # Optional metadata for the application that provided this data. # Output only. Captures metadata for the application that provided this data.
+          "googleWebClientId": "A String", # Output only. The Google OAuth 2.0 client ID of the web application or service that recorded the data. This is the client ID used during the Google OAuth flow to obtain user credentials. This field is system-populated when the data is uploaded from Google Web API.
+          "packageName": "A String", # Output only. A unique identifier for the mobile application that was the source of the data. This is typically the application's package name on Android (e.g., `com.google.fitbit`) or the bundle ID on iOS. This field is informational and helps trace data origin. This field is system-populated when the data is uploaded from the Fitbit mobile application, Health Connect or Health Kit.
+          "webClientId": "A String", # Output only. The client ID of the application that recorded the data. This ID is a legacy Fitbit API client ID, which is different from a Google OAuth client ID. Example format: `ABC123`. This field is system-populated and used for tracing data from legacy Fitbit API integrations. This field is system-populated when the data is uploaded from a legacy Fitbit API integration.
+        },
+        "device": { # Captures metadata about the device that recorded the measurement. # Optional. Captures metadata for raw data points originating from devices. We expect this data source to be used for data points written on device sync.
+          "displayName": "A String", # Optional. An optional name for the device.
+          "formFactor": "A String", # Optional. Captures the form factor of the device.
+          "manufacturer": "A String", # Optional. An optional manufacturer of the device.
+        },
+        "platform": "A String", # Output only. Captures the platform that uploaded the data.
+        "recordingMethod": "A String", # Optional. Captures how the data was recorded.
+      },
+      "distance": { # Distance traveled over an interval of time. # Optional. Data for points in the `distance` 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).
+        },
+        "millimeters": "A String", # Required. Distance in millimeters over the observed interval.
+      },
+      "electrocardiogram": { # Represents an Electrocardiogram (ECG) measurement session. This data type is based on SaMD feature and any changes to it may require additional review. # Optional. Data for points in the `electrocardiogram` session data type collection.
+        "beatsPerMinuteAvg": "A String", # Optional. Average heart rate recorded during ECG reading in beats per minute.
+        "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. NOTE: Historical ECG data lacks timezone offsets, so `start_utc_offset` and `end_utc_offset` will be missing or default to zero. As a result, the civil time fields within this interval will default to UTC. It is recommended to use physical time fields instead for accurate time referencing. NOTE: The `start_time` and `end_time` of the interval are equal, representing the reading time.
+          "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. Session end time in civil time in the timezone the subject is in at the end of the session.
+            "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+            "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. The end time of the observed session.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+          "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).
+        },
+        "leadNumber": 42, # Optional. The number of leads used for ECG reading.
+        "medicalDeviceInfo": { # Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI). # Output only. The meta information for the compatible device used to conduct the measurement. ECG measurements typically populate `firmware_version`, `feature_version`, and `device_model`.
+          "algorithmVersion": "A String", # Output only. The algorithm version used by the feature.
+          "deviceModel": "A String", # Output only. The model name or device type of the compatible device used to collect the data.
+          "featureVersion": "A String", # Output only. The version of the feature/app running on the device.
+          "firmwareVersion": "A String", # Output only. The firmware version running on the compatible device used to collect the data.
+          "serviceVersion": "A String", # Output only. The service version used by the feature.
+        },
+        "millivoltsScalingFactor": 42, # Optional. The factor by which to divide waveform samples to get voltage in millivolts: millivolts = waveform_sample / millivolts_scaling_factor.
+        "resultClassification": "A String", # Optional. The result classification of the ECG reading.
+        "samplingFrequencyHertz": 42, # Optional. The sampling frequency of waveform samples in hertz.
+        "waveformSamples": [ # Optional. An array of voltage values representing lead I ECG values. Each sample represents voltage difference in ECG graph. The first value in array corresponds to the start of the reading.
+          42,
+        ],
+      },
+      "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. 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
+            "eventUtcOffset": "A String", # Required. Exercise event time offset from UTC
+            "exerciseEventType": "A String", # Required. The type of the event, such as start, stop, pause, resume.
+          },
+        ],
+        "exerciseMetadata": { # Additional exercise metadata. # Optional. Additional exercise metadata.
+          "hasGps": True or False, # Optional. Whether the exercise had GPS tracking.
+          "poolLengthMillimeters": "A String", # Optional. Pool length in millimeters. Only present in the swimming exercises.
+        },
+        "exerciseType": "A String", # Required. The type of activity performed during an exercise.
+        "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed exercise 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+            "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+            "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. The end time of the observed session.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+          "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).
+        },
+        "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this exercise ( )
+          "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+          "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+          "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+          "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+          "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+          "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+          "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+          "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+            "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+            "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+            "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+            "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+          },
+          "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+            "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+            "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+            "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+            "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+            "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+          },
+          "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+          "steps": "A String", # Optional. Total steps taken during the exercise.
+          "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+        },
+        "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+        "splitSummaries": [ # Optional. Laps or splits recorded within an exercise. Laps could be split based on distance or other criteria (duration, etc.) Laps should not be overlapping with each other.
+          { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+            "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+            "endTime": "A String", # Required. Lap end time
+            "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+            "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+              "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+              "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+              "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+              "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+              "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+              "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+              "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+              "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+                "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+                "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+                "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+                "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+              },
+              "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+                "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+                "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+                "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+                "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+                "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+              },
+              "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+              "steps": "A String", # Optional. Total steps taken during the exercise.
+              "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+            },
+            "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+            "startTime": "A String", # Required. Lap start time
+            "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+          },
+        ],
+        "splits": [ # Optional. The default split is 1 km or 1 mile. - if the movement distance is less than the default, then there are no splits - if the movement distance is greater than or equal to the default, then we have splits
+          { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+            "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+            "endTime": "A String", # Required. Lap end time
+            "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+            "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+              "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+              "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+              "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+              "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+              "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+              "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+              "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+              "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+                "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+                "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+                "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+                "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+              },
+              "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+                "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+                "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+                "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+                "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+                "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+              },
+              "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+              "steps": "A String", # Optional. Total steps taken during the exercise.
+              "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+            },
+            "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+            "startTime": "A String", # Required. Lap start time
+            "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+          },
+        ],
+        "updateTime": "A String", # Output only. This is the timestamp of the last update to the exercise.
+      },
+      "floors": { # Gained elevation measured in floors over the time interval # Optional. Data for points in the `floors` interval data type collection.
+        "count": "A String", # Required. Number of floors in the recorded interval
+        "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).
+        },
+      },
+      "food": { # Represents a food item. # Optional. The food details.
+        "accessLevel": "A String", # Required. The access level of the food.
+        "brand": "A String", # Optional. The brand of the food.
+        "defaultServing": { # Represents different properties and information about the serving of a specific food. # Required. Value representing the default serving of the food.
+          "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported.
+          "foodMeasurementUnit": "A String", # Required. Food measurement unit
+          "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram").
+          "foodMeasurementUnitDisplayNamePlural": "A String", # Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams").
+          "multiplier": 3.14, # Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving.
+        },
+        "description": "A String", # Optional. The description of the food.
+        "displayName": "A String", # Required. The display name of the food.
+        "energyAvg": { # Represents the energy quantity. # Optional. Value representing the average energy of the food for the default serving.
+          "kcal": 3.14, # Required. The energy value in kilocalories.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+        "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the food for the default serving.
+          "kcal": 3.14, # Required. The energy value in kilocalories.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+        "energyMax": { # Represents the energy quantity. # Optional. Value representing the maximum energy of the food for the default serving.
+          "kcal": 3.14, # Required. The energy value in kilocalories.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+        "energyMin": { # Represents the energy quantity. # Optional. Value representing the minimum energy of the food for the default serving.
+          "kcal": 3.14, # Required. The energy value in kilocalories.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+        "languageCode": "A String", # Optional. The language code where the food is available in format xx-XX. Supported values are defined in Settings.food_language_code.
+        "mealType": "A String", # Optional. The meal type associated with this food.
+        "nutrients": [ # Optional. Value representing the nutrients of the food for the default serving.
+          { # Represents the quantity of a nutrient.
+            "nutrient": "A String", # Required. The nutrient type.
+            "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams.
+              "grams": 3.14, # Required. The weight value in grams.
+              "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+            },
+          },
+        ],
+        "servings": [ # Optional. The serving of the food.
+          { # Represents different properties and information about the serving of a specific food.
+            "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported.
+            "foodMeasurementUnit": "A String", # Required. Food measurement unit
+            "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram").
+            "foodMeasurementUnitDisplayNamePlural": "A String", # Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams").
+            "multiplier": 3.14, # Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving.
+          },
+        ],
+        "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the food for the default serving.
+          "grams": 3.14, # Required. The weight value in grams.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+        "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the food for the default serving.
+          "grams": 3.14, # Required. The weight value in grams.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+      },
+      "foodMeasurementUnit": { # Represents a food measurement unit. # Optional. The food measurement unit details.
+        "displayName": "A String", # Required. The display name of the food measurement unit (e.g., "gram", "piece").
+        "pluralDisplayName": "A String", # Optional. The plural display name of the food measurement unit (e.g., "grams", "pieces").
+      },
+      "heartRate": { # A heart rate measurement. # Optional. Data for points in the `heart-rate` sample data type collection.
+        "beatsPerMinute": "A String", # Required. The heart rate value in beats per minute.
+        "metadata": { # Heart rate metadata. # Optional. Metadata about the heart rate sample.
+          "motionContext": "A String", # Optional. Indicates the user’s level of activity when the heart rate sample was measured
+          "sensorLocation": "A String", # Optional. Indicates the location of the sensor that measured the heart rate.
+        },
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. Observation time
+          "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).
+        },
+      },
+      "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection.
+        "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces.
+          "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz).
+          "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz).
+        },
+        "rootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time of the heart rate variability measurement.
+          "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).
+        },
+        "standardDeviationMilliseconds": 3.14, # Optional. The standard deviation of the heart rate variability measurement.
+      },
+      "height": { # Body height measurement. # Optional. Data for points in the `height` sample data type collection.
+        "heightMillimeters": "A String", # Required. Height of the user in millimeters.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the height was recorded.
+          "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).
+        },
+      },
+      "hydrationLog": { # Holds information about a user logged hydration. # Optional. Data for points in the `hydration-log` session data type collection.
+        "amountConsumed": { # Represents the volume quantity. # Required. Amount of liquid (ex. water) consumed.
+          "milliliters": 3.14, # Required. Value representing the volume in milliliters.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit, used only for user-facing input and display purposes. In the API format, all volume quantities are converted to milliliters.
+        },
+        "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+            "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+            "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. The end time of the observed session.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+          "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).
+        },
+      },
+      "irregularRhythmNotification": { # Represents an Irregular Rhythm Notification alert, indicating a potential sign of atrial fibrillation (AFib). This data type is based on SaMD feature and any changes to it may require additional review. # Optional. Data for points in the `irregular-rhythm-notification` session data type collection.
+        "alertWindows": [ # Optional. The overlapping analysis windows that were used to evaluate rhythm for potential AFib, containing specific information about the user's heart rhythm.
+          { # An analysis window evaluated for AFib. Note: The current version of the algorithm will only produce alerts if all windows are positive. So anything returned from the API will always have the positive bit set to true. Internally, windows can be negative, however. We never save "inconclusive" windows (they aren't produced by the algorithm).
+            "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. The end time of the analysis window.
+            "endUtcOffset": "A String", # Required. The UTC offset of the user's timezone when the analysis window ended.
+            "heartBeats": [ # Optional. All heart beats in the interval contained in this analysis window.
+              { # A single heart beat measurement.
+                "beatsPerMinute": 42, # Required. The beats-per-minute value extrapolated from the time before the following heart beat. This is calculated as 60000 / rr, where rr is the gap between heart beats in milliseconds (IBI - Interbeat Interval).
+                "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 heart beat measurement.
+                "utcOffset": "A String", # Required. The UTC offset of the user's timezone when the heart beat measurement occurred.
+              },
+            ],
+            "positive": True or False, # Optional. Flag indicating whether the window was positive for AFib or not. A `true` value indicates that AFib was detected in this window. A `false` value means AFib was not detected, but does not guarantee the absence of AFib.
+            "startTime": "A String", # Required. Observed interval. The start time of the analysis window.
+            "startUtcOffset": "A String", # Required. The UTC offset of the user's timezone when the analysis window started.
+          },
+        ],
+        "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+            "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+            "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. The end time of the observed session.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+          "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).
+        },
+        "medicalDeviceInfo": { # Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI). # Output only. The meta information for the compatible device used to conduct the measurement. Irregular Rhythm Notification measurements typically populate `algorithm_version`, `service_version`, and `device_model`.
+          "algorithmVersion": "A String", # Output only. The algorithm version used by the feature.
+          "deviceModel": "A String", # Output only. The model name or device type of the compatible device used to collect the data.
+          "featureVersion": "A String", # Output only. The version of the feature/app running on the device.
+          "firmwareVersion": "A String", # Output only. The firmware version running on the compatible device used to collect the data.
+          "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`).
+          "kcal": 3.14, # Required. The energy value in kilocalories.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+        "energyFromFat": { # Represents the energy quantity. # Optional. The energy from fat, measured in kilocalories (`kcal`).
+          "kcal": 3.14, # Required. The energy value in kilocalories.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+        "food": "A String", # Optional. The resource name of the Food item. Required when creating a nutrition log from an identified food. For anonymous food logs, use the `food_display_name` field instead.
+        "foodDisplayName": "A String", # The display name of the food. For identified food logs, this is populated automatically from the referenced food.
+        "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. The time window when the food was logged.
+          "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. Session end time in civil time in the timezone the subject is in at the end of the session.
+            "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+            "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. The end time of the observed session.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+          "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).
+        },
+        "mealType": "A String", # Optional. The meal category. One of `BREAKFAST`, `LUNCH`, `DINNER`, or `SNACK`.
+        "nutrients": [ # Optional. An array of individual nutrient values for the nutrition log.
+          { # Represents the quantity of a nutrient.
+            "nutrient": "A String", # Required. The nutrient type.
+            "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams.
+              "grams": 3.14, # Required. The weight value in grams.
+              "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+            },
+          },
+        ],
+        "serving": { # Represents different properties and information about the serving of a specific food. # Optional. The serving information for the logged food.
+          "amount": 3.14, # Optional. The number of servings.
+          "foodMeasurementUnit": "A String", # Required. Food measurement unit
+          "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram").
+        },
+        "totalCarbohydrate": { # Represents the weight quantity. # Optional. The total carbohydrate content, measured in grams.
+          "grams": 3.14, # Required. The weight value in grams.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+        "totalFat": { # Represents the weight quantity. # Optional. The total fat content, measured in grams.
+          "grams": 3.14, # Required. The weight value in grams.
+          "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.
+          "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).
+        },
+      },
+      "respiratoryRateSleepSummary": { # Records respiratory rate details during sleep. Can have multiple per day if the user sleeps multiple times. # Optional. Data for points in the `respiratory-rate-sleep-summary` sample data type collection.
+        "deepSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for deep sleep.
+          "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+          "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+          "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+        },
+        "fullSleepStats": { # Respiratory rate statistics for a given sleep stage. # Required. Full respiratory rate statistics.
+          "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+          "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+          "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+        },
+        "lightSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for light sleep.
+          "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+          "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+          "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+        },
+        "remSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for REM sleep.
+          "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+          "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+          "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+        },
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which respiratory rate 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).
+        },
+      },
+      "runVo2Max": { # VO2 max value calculated based on the user's running activity. Value stored in ml/kg/min. # Optional. Data for points in the `run-vo2-max` sample data type collection.
+        "runVo2Max": 3.14, # Required. Run VO2 max value in ml/kg/min.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the metric 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).
+        },
+      },
+      "sedentaryPeriod": { # SedentaryPeriod SedentaryPeriod data represents the periods of time that the user was sedentary (i.e. not moving while wearing the device). # Optional. Data for points in the `sedentary-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).
+        },
+      },
+      "sleep": { # A sleep session possibly including stages. # Optional. Data for points in the `sleep` session data type collection.
+        "createTime": "A String", # Output only. Creation time of this sleep observation.
+        "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed sleep 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+            "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+            "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. The end time of the observed session.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+          "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: `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.
+          "stagesStatus": "A String", # Output only. Sleep stages algorithm processing status.
+        },
+        "outOfBedSegments": [ # Optional. “Out of bed” segments that can overlap with sleep stages.
+          { # A time interval to represent an out-of-bed segment.
+            "endTime": "A String", # Required. Segment end time.
+            "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the segment relative to the Coordinated Universal Time (UTC).
+            "startTime": "A String", # Required. Segment tart time.
+            "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the segment relative to the Coordinated Universal Time (UTC).
+          },
+        ],
+        "shortAwakenings": [ # Output only. List of short awake segments (under a set threshold) that are part of the sleep session. These can overlap with sleep stages.
+          { # Sleep stage segment.
+            "createTime": "A String", # Output only. Creation time of this sleep stages segment.
+            "endTime": "A String", # Required. Sleep stage end time.
+            "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC).
+            "startTime": "A String", # Required. Sleep stage start time.
+            "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC).
+            "type": "A String", # Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+            "updateTime": "A String", # Output only. Last update time of this sleep stages segment.
+          },
+        ],
+        "stages": [ # Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.
+          { # Sleep stage segment.
+            "createTime": "A String", # Output only. Creation time of this sleep stages segment.
+            "endTime": "A String", # Required. Sleep stage end time.
+            "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC).
+            "startTime": "A String", # Required. Sleep stage start time.
+            "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC).
+            "type": "A String", # Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+            "updateTime": "A String", # Output only. Last update time of this sleep stages segment.
+          },
+        ],
+        "summary": { #  Sleep summary: metrics and stages summary. # Output only. Sleep summary: metrics and stages summary.
+          "minutesAfterWakeUp": "A String", # Output only. Minutes after wake up calculated by restlessness algorithm.
+          "minutesAsleep": "A String", # Output only. Total number of minutes asleep. For classic sleep it is the sum of ASLEEP stages (excluding AWAKE and RESTLESS). For "stages" sleep it is the sum of LIGHT, REM and DEEP stages (excluding AWAKE).
+          "minutesAwake": "A String", # Output only. Total number of minutes awake. It is a sum of all AWAKE stages.
+          "minutesInSleepPeriod": "A String", # Output only. Delta between wake time and bedtime. It is the sum of all stages.
+          "minutesToFallAsleep": "A String", # Output only. Minutes to fall asleep calculated by restlessness algorithm.
+          "stagesSummary": [ # Output only. List of summaries (total duration and segment count) per each sleep stage type.
+            { # Total duration and segment count for a stage.
+              "count": "A String", # Output only. Number of sleep stages segments.
+              "minutes": "A String", # Output only. Total duration in minutes of a sleep stage.
+              "type": "A String", # Output only. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+            },
+          ],
+        },
+        "type": "A String", # Optional. SleepType: classic or stages.
+        "updateTime": "A String", # Output only. Last update time of this sleep observation.
+      },
+      "steps": { # Step count over the time interval. # Optional. Data for points in the `steps` interval data type collection.
+        "count": "A String", # Required. Number of steps in the recorded interval.
+        "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).
+        },
+      },
+      "swimLengthsData": { # Swim lengths data over the time interval. # Optional. Data for points in the `swim-lengths-data` 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).
+        },
+        "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.
+          "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).
+        },
+      },
+      "vo2Max": { # VO2 max measurement. # Optional. Data for points in the `vo2-max` sample data type collection.
+        "measurementMethod": "A String", # Optional. The method used to measure the VO2 max value.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which VO2 max 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).
+        },
+        "vo2Max": 3.14, # Required. VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+      },
+      "weight": { # Body weight measurement. # Optional. Data for points in the `weight` sample data type collection.
+        "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the weight 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).
+        },
+        "weightGrams": 3.14, # Required. Weight of a user in grams.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Next page token, empty if the response is complete
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, x__xgafv=None) +
Updates a single identifiable data point. If a data point with the specified `name` is not found, the request will fail.
+
+Args:
+  name: 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. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A computed or recorded metric.
+  "activeEnergyBurned": { # Energy burned as part of an activity, excluding the basal energy burn. # Optional. Data for points in the `active-energy-burned` 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).
+    },
+    "kcal": 3.14, # Required. Energy burned during an activity, measured in kilocalories.
+  },
+  "activeMinutes": { # Record of active minutes in a given time interval. # Optional. Data for points in the `active-minutes` interval data type collection.
+    "activeMinutesByActivityLevel": [ # Required. Active minutes by activity level. At most one record per activity level is allowed.
+      { # Active minutes at a given activity level.
+        "activeMinutes": "A String", # Required. Number of whole minutes spent in activity.
+        "activityLevel": "A String", # Required. The level of activity.
+      },
+    ],
+    "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).
+    },
+  },
+  "activeZoneMinutes": { # Record of active zone minutes in a given time interval. # Optional. Data for points in the `active-zone-minutes` interval data type collection, measured in minutes.
+    "activeZoneMinutes": "A String", # Required. Number of Active Zone Minutes earned in the given time interval. Note: active_zone_minutes equals to 1 for low intensity (fat burn) zones or 2 for high intensity zones (cardio, peak).
+    "heartRateZone": "A String", # Required. Heart rate zone in which the active zone minutes have been earned, in the given time interval.
+    "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).
+    },
+  },
+  "activityLevel": { # Internal type to capture activity level during a certain time interval. # Optional. Data for points in the `activity-level` daily data type collection.
+    "activityLevelType": "A String", # Required. Activity level type in the given time interval.
+    "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).
+    },
+  },
+  "altitude": { # Captures the altitude gain (i.e. deltas), and not level above sea, for a user in millimeters. # Optional. Data for points in the `altitude` interval data type collection.
+    "gainMillimeters": "A String", # Required. Altitude gain in millimeters over the observed interval.
+    "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).
+    },
+  },
+  "basalEnergyBurned": { # Number of calories burned due to basal metabolic rate (BMR) over a period of time. # Optional. Data for points in the `basal-energy-burned` 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).
+    },
+    "kcal": 3.14, # Required. Number of calories burned due to basal metabolic rate in kilocalories over the observed interval.
+  },
+  "bloodGlucose": { # Represents a blood glucose level measurement. LINT: LEGACY_NAMES # Optional. Data for points in the `blood-glucose` sample data type collection.
+    "bloodGlucoseMilligramsPerDeciliter": 3.14, # Required. Blood glucose level concentration in mg/dL.
+    "mealType": "A String", # Optional. Meal type of the measurement.
+    "measurementSource": "A String", # Optional. Source of the measurement.
+    "measurementTiming": "A String", # Optional. Timing of the measurement.
+    "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which blood glucose 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).
+    },
+    "specimen": "A String", # Optional. Type of body fluid used to measure the blood glucose.
+  },
+  "bodyFat": { # Body fat measurement. # Optional. Data for points in the `body-fat` sample data type collection.
+    "percentage": 3.14, # Required. Body fat percentage, in range [0, 100].
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which body fat 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).
+    },
+  },
+  "coreBodyTemperature": { # Core body temperature measurement, distinct from peripheral body temperature, reflects the temperature of the body's internal organs. # Optional. Data for points in the `core-body-temperature` sample data type collection.
+    "id": "A String", # Optional. The unique identifier of the core body temperature measurement.
+    "measurementLocation": "A String", # Optional. The location of the core body temperature measurement.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which core body temperature 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).
+    },
+    "temperatureCelsius": 3.14, # Required. The core body temperature in Celsius.
+  },
+  "dailyHeartRateVariability": { # Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds` # Optional. Data for points in the `daily-heart-rate-variability` daily data type collection.
+    "averageHeartRateVariabilityMilliseconds": 3.14, # Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats.
+    "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. Date (in the user's timezone) of heart rate variability measurement.
+      "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.
+    },
+    "deepSleepRootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences (RMSSD) value during deep sleep.
+    "entropy": 3.14, # Optional. The Shanon entropy of heartbeat intervals. Entropy quantifies randomness or disorder in a system. High entropy indicates high HRV. Entropy is measured from the histogram of time interval between successive heart beats values measured during sleep.
+    "nonRemHeartRateBeatsPerMinute": "A String", # Optional. Non-REM heart rate
+  },
+  "dailyHeartRateZones": { # User's heart rate zone thresholds based on the Karvonen algorithm for a specific day. # Optional. Data for points in the `daily-heart-rate-zones` daily data type collection.
+    "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. Date (in user's timezone) of the heart rate zones record.
+      "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.
+    },
+    "heartRateZones": [ # Required. The heart rate zones.
+      { # The heart rate zone.
+        "heartRateZoneType": "A String", # Required. The heart rate zone type.
+        "maxBeatsPerMinute": "A String", # Required. Maximum heart rate for this zone in beats per minute.
+        "minBeatsPerMinute": "A String", # Required. Minimum heart rate for this zone in beats per minute.
+      },
+    ],
+  },
+  "dailyOxygenSaturation": { # A daily oxygen saturation (SpO2) record. Represents the user's daily oxygen saturation summary, typically calculated during sleep. # Optional. Data for points in the `daily-oxygen-saturation` daily data type collection.
+    "averagePercentage": 3.14, # Required. The average value of the oxygen saturation samples during the sleep.
+    "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. Date (in user's timezone) of the daily oxygen saturation record.
+      "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.
+    },
+    "lowerBoundPercentage": 3.14, # Required. The lower bound of the confidence interval of oxygen saturation samples during sleep.
+    "standardDeviationPercentage": 3.14, # Optional. Standard deviation of the daily oxygen saturation averages from the past 7-30 days.
+    "upperBoundPercentage": 3.14, # Required. The upper bound of the confidence interval of oxygen saturation samples during sleep.
+  },
+  "dailyRespiratoryRate": { # A daily average respiratory rate (breaths per minute) for a day of the year. One data point per day calculated for the main sleep. # Optional. Data for points in the `daily-respiratory-rate` daily data type collection.
+    "breathsPerMinute": 3.14, # Required. The average number of breaths taken per minute.
+    "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. The date on which the respiratory rate was measured.
+      "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.
+    },
+  },
+  "dailyRestingHeartRate": { # Measures the daily resting heart rate for a user, calculated using the all day heart rate measurements. # Optional. Data for points in the `daily-resting-heart-rate` daily data type collection.
+    "beatsPerMinute": "A String", # Required. The resting heart rate value in beats per minute.
+    "dailyRestingHeartRateMetadata": { # Metadata for the daily resting heart rate. # Optional. Metadata for the daily resting heart rate.
+      "calculationMethod": "A String", # Required. The method used to calculate the resting heart rate.
+    },
+    "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. Date (in the user's timezone) of the resting heart rate measurement.
+      "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.
+    },
+  },
+  "dailySleepTemperatureDerivations": { # Provides derived sleep temperature values, calculated from skin or internal device temperature readings during sleep. # Optional. Data for points in the `daily-sleep-temperature-derivations` daily data type collection.
+    "baselineTemperatureCelsius": 3.14, # Optional. The user's baseline skin temperature. It is the median of the user's nightly skin temperature over the past 30 days.
+    "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. Date for which the sleep temperature derivations are calculated.
+      "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.
+    },
+    "nightlyTemperatureCelsius": 3.14, # Required. The user's nightly skin temperature. It is the mean of skin temperature samples taken from the user’s sleep.
+    "relativeNightlyStddev30dCelsius": 3.14, # Optional. The standard deviation of the user’s relative nightly skin temperature (temperature - baseline) over the past 30 days.
+  },
+  "dailyVo2Max": { # Contains a daily summary of the user's VO2 max (cardio fitness score), which is the maximum rate of oxygen the body can use during exercise. # Optional. Data for points in the `daily-vo2-max` daily data type collection.
+    "cardioFitnessLevel": "A String", # Optional. Represents the user's cardio fitness level based on their VO2 max.
+    "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. The date for which the Daily VO2 max was measured.
+      "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.
+    },
+    "estimated": True or False, # Optional. An estimated field is added to indicate when the confidence has decreased sufficiently to consider the value an estimation.
+    "vo2Max": 3.14, # Required. Daily VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+    "vo2MaxCovariance": 3.14, # Optional. The covariance of the VO2 max value.
+  },
+  "dataSource": { # Data Source definition to track the origin of data. Each health data point, regardless of the complexity or data model (whether a simple step count or a detailed sleep session) must retain information about its source of origin (e.g. the device or app that collected it). # Optional. Data source information for the metric
+    "application": { # Optional metadata for the application that provided this data. # Output only. Captures metadata for the application that provided this data.
+      "googleWebClientId": "A String", # Output only. The Google OAuth 2.0 client ID of the web application or service that recorded the data. This is the client ID used during the Google OAuth flow to obtain user credentials. This field is system-populated when the data is uploaded from Google Web API.
+      "packageName": "A String", # Output only. A unique identifier for the mobile application that was the source of the data. This is typically the application's package name on Android (e.g., `com.google.fitbit`) or the bundle ID on iOS. This field is informational and helps trace data origin. This field is system-populated when the data is uploaded from the Fitbit mobile application, Health Connect or Health Kit.
+      "webClientId": "A String", # Output only. The client ID of the application that recorded the data. This ID is a legacy Fitbit API client ID, which is different from a Google OAuth client ID. Example format: `ABC123`. This field is system-populated and used for tracing data from legacy Fitbit API integrations. This field is system-populated when the data is uploaded from a legacy Fitbit API integration.
+    },
+    "device": { # Captures metadata about the device that recorded the measurement. # Optional. Captures metadata for raw data points originating from devices. We expect this data source to be used for data points written on device sync.
+      "displayName": "A String", # Optional. An optional name for the device.
+      "formFactor": "A String", # Optional. Captures the form factor of the device.
+      "manufacturer": "A String", # Optional. An optional manufacturer of the device.
+    },
+    "platform": "A String", # Output only. Captures the platform that uploaded the data.
+    "recordingMethod": "A String", # Optional. Captures how the data was recorded.
+  },
+  "distance": { # Distance traveled over an interval of time. # Optional. Data for points in the `distance` 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).
+    },
+    "millimeters": "A String", # Required. Distance in millimeters over the observed interval.
+  },
+  "electrocardiogram": { # Represents an Electrocardiogram (ECG) measurement session. This data type is based on SaMD feature and any changes to it may require additional review. # Optional. Data for points in the `electrocardiogram` session data type collection.
+    "beatsPerMinuteAvg": "A String", # Optional. Average heart rate recorded during ECG reading in beats per minute.
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. NOTE: Historical ECG data lacks timezone offsets, so `start_utc_offset` and `end_utc_offset` will be missing or default to zero. As a result, the civil time fields within this interval will default to UTC. It is recommended to use physical time fields instead for accurate time referencing. NOTE: The `start_time` and `end_time` of the interval are equal, representing the reading time.
+      "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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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).
+    },
+    "leadNumber": 42, # Optional. The number of leads used for ECG reading.
+    "medicalDeviceInfo": { # Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI). # Output only. The meta information for the compatible device used to conduct the measurement. ECG measurements typically populate `firmware_version`, `feature_version`, and `device_model`.
+      "algorithmVersion": "A String", # Output only. The algorithm version used by the feature.
+      "deviceModel": "A String", # Output only. The model name or device type of the compatible device used to collect the data.
+      "featureVersion": "A String", # Output only. The version of the feature/app running on the device.
+      "firmwareVersion": "A String", # Output only. The firmware version running on the compatible device used to collect the data.
+      "serviceVersion": "A String", # Output only. The service version used by the feature.
+    },
+    "millivoltsScalingFactor": 42, # Optional. The factor by which to divide waveform samples to get voltage in millivolts: millivolts = waveform_sample / millivolts_scaling_factor.
+    "resultClassification": "A String", # Optional. The result classification of the ECG reading.
+    "samplingFrequencyHertz": 42, # Optional. The sampling frequency of waveform samples in hertz.
+    "waveformSamples": [ # Optional. An array of voltage values representing lead I ECG values. Each sample represents voltage difference in ECG graph. The first value in array corresponds to the start of the reading.
+      42,
+    ],
+  },
+  "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. 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
+        "eventUtcOffset": "A String", # Required. Exercise event time offset from UTC
+        "exerciseEventType": "A String", # Required. The type of the event, such as start, stop, pause, resume.
+      },
+    ],
+    "exerciseMetadata": { # Additional exercise metadata. # Optional. Additional exercise metadata.
+      "hasGps": True or False, # Optional. Whether the exercise had GPS tracking.
+      "poolLengthMillimeters": "A String", # Optional. Pool length in millimeters. Only present in the swimming exercises.
+    },
+    "exerciseType": "A String", # Required. The type of activity performed during an exercise.
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed exercise 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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).
+    },
+    "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this exercise ( )
+      "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+      "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+      "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+      "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+      "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+      "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+      "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+      "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+        "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+        "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+        "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+        "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+      },
+      "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+        "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+        "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+        "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+        "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+        "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+      },
+      "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+      "steps": "A String", # Optional. Total steps taken during the exercise.
+      "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+    },
+    "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+    "splitSummaries": [ # Optional. Laps or splits recorded within an exercise. Laps could be split based on distance or other criteria (duration, etc.) Laps should not be overlapping with each other.
+      { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+        "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+        "endTime": "A String", # Required. Lap end time
+        "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+        "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+          "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+          "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+          "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+          "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+          "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+          "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+          "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+          "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+            "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+            "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+            "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+            "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+          },
+          "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+            "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+            "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+            "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+            "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+            "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+          },
+          "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+          "steps": "A String", # Optional. Total steps taken during the exercise.
+          "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+        },
+        "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+        "startTime": "A String", # Required. Lap start time
+        "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+      },
+    ],
+    "splits": [ # Optional. The default split is 1 km or 1 mile. - if the movement distance is less than the default, then there are no splits - if the movement distance is greater than or equal to the default, then we have splits
+      { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+        "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+        "endTime": "A String", # Required. Lap end time
+        "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+        "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+          "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+          "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+          "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+          "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+          "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+          "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+          "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+          "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+            "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+            "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+            "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+            "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+          },
+          "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+            "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+            "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+            "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+            "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+            "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+          },
+          "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+          "steps": "A String", # Optional. Total steps taken during the exercise.
+          "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+        },
+        "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+        "startTime": "A String", # Required. Lap start time
+        "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+      },
+    ],
+    "updateTime": "A String", # Output only. This is the timestamp of the last update to the exercise.
+  },
+  "floors": { # Gained elevation measured in floors over the time interval # Optional. Data for points in the `floors` interval data type collection.
+    "count": "A String", # Required. Number of floors in the recorded interval
+    "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).
+    },
+  },
+  "food": { # Represents a food item. # Optional. The food details.
+    "accessLevel": "A String", # Required. The access level of the food.
+    "brand": "A String", # Optional. The brand of the food.
+    "defaultServing": { # Represents different properties and information about the serving of a specific food. # Required. Value representing the default serving of the food.
+      "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported.
+      "foodMeasurementUnit": "A String", # Required. Food measurement unit
+      "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram").
+      "foodMeasurementUnitDisplayNamePlural": "A String", # Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams").
+      "multiplier": 3.14, # Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving.
+    },
+    "description": "A String", # Optional. The description of the food.
+    "displayName": "A String", # Required. The display name of the food.
+    "energyAvg": { # Represents the energy quantity. # Optional. Value representing the average energy of the food for the default serving.
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the food for the default serving.
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "energyMax": { # Represents the energy quantity. # Optional. Value representing the maximum energy of the food for the default serving.
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "energyMin": { # Represents the energy quantity. # Optional. Value representing the minimum energy of the food for the default serving.
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "languageCode": "A String", # Optional. The language code where the food is available in format xx-XX. Supported values are defined in Settings.food_language_code.
+    "mealType": "A String", # Optional. The meal type associated with this food.
+    "nutrients": [ # Optional. Value representing the nutrients of the food for the default serving.
+      { # Represents the quantity of a nutrient.
+        "nutrient": "A String", # Required. The nutrient type.
+        "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams.
+          "grams": 3.14, # Required. The weight value in grams.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+      },
+    ],
+    "servings": [ # Optional. The serving of the food.
+      { # Represents different properties and information about the serving of a specific food.
+        "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported.
+        "foodMeasurementUnit": "A String", # Required. Food measurement unit
+        "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram").
+        "foodMeasurementUnitDisplayNamePlural": "A String", # Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams").
+        "multiplier": 3.14, # Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving.
+      },
+    ],
+    "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the food for the default serving.
+      "grams": 3.14, # Required. The weight value in grams.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the food for the default serving.
+      "grams": 3.14, # Required. The weight value in grams.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+  },
+  "foodMeasurementUnit": { # Represents a food measurement unit. # Optional. The food measurement unit details.
+    "displayName": "A String", # Required. The display name of the food measurement unit (e.g., "gram", "piece").
+    "pluralDisplayName": "A String", # Optional. The plural display name of the food measurement unit (e.g., "grams", "pieces").
+  },
+  "heartRate": { # A heart rate measurement. # Optional. Data for points in the `heart-rate` sample data type collection.
+    "beatsPerMinute": "A String", # Required. The heart rate value in beats per minute.
+    "metadata": { # Heart rate metadata. # Optional. Metadata about the heart rate sample.
+      "motionContext": "A String", # Optional. Indicates the user’s level of activity when the heart rate sample was measured
+      "sensorLocation": "A String", # Optional. Indicates the location of the sensor that measured the heart rate.
+    },
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. Observation time
+      "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).
+    },
+  },
+  "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection.
+    "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces.
+      "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz).
+      "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz).
+    },
+    "rootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time of the heart rate variability measurement.
+      "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).
+    },
+    "standardDeviationMilliseconds": 3.14, # Optional. The standard deviation of the heart rate variability measurement.
+  },
+  "height": { # Body height measurement. # Optional. Data for points in the `height` sample data type collection.
+    "heightMillimeters": "A String", # Required. Height of the user in millimeters.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the height was recorded.
+      "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).
+    },
+  },
+  "hydrationLog": { # Holds information about a user logged hydration. # Optional. Data for points in the `hydration-log` session data type collection.
+    "amountConsumed": { # Represents the volume quantity. # Required. Amount of liquid (ex. water) consumed.
+      "milliliters": 3.14, # Required. Value representing the volume in milliliters.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit, used only for user-facing input and display purposes. In the API format, all volume quantities are converted to milliliters.
+    },
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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).
+    },
+  },
+  "irregularRhythmNotification": { # Represents an Irregular Rhythm Notification alert, indicating a potential sign of atrial fibrillation (AFib). This data type is based on SaMD feature and any changes to it may require additional review. # Optional. Data for points in the `irregular-rhythm-notification` session data type collection.
+    "alertWindows": [ # Optional. The overlapping analysis windows that were used to evaluate rhythm for potential AFib, containing specific information about the user's heart rhythm.
+      { # An analysis window evaluated for AFib. Note: The current version of the algorithm will only produce alerts if all windows are positive. So anything returned from the API will always have the positive bit set to true. Internally, windows can be negative, however. We never save "inconclusive" windows (they aren't produced by the algorithm).
+        "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. The end time of the analysis window.
+        "endUtcOffset": "A String", # Required. The UTC offset of the user's timezone when the analysis window ended.
+        "heartBeats": [ # Optional. All heart beats in the interval contained in this analysis window.
+          { # A single heart beat measurement.
+            "beatsPerMinute": 42, # Required. The beats-per-minute value extrapolated from the time before the following heart beat. This is calculated as 60000 / rr, where rr is the gap between heart beats in milliseconds (IBI - Interbeat Interval).
+            "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 heart beat measurement.
+            "utcOffset": "A String", # Required. The UTC offset of the user's timezone when the heart beat measurement occurred.
+          },
+        ],
+        "positive": True or False, # Optional. Flag indicating whether the window was positive for AFib or not. A `true` value indicates that AFib was detected in this window. A `false` value means AFib was not detected, but does not guarantee the absence of AFib.
+        "startTime": "A String", # Required. Observed interval. The start time of the analysis window.
+        "startUtcOffset": "A String", # Required. The UTC offset of the user's timezone when the analysis window started.
+      },
+    ],
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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).
+    },
+    "medicalDeviceInfo": { # Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI). # Output only. The meta information for the compatible device used to conduct the measurement. Irregular Rhythm Notification measurements typically populate `algorithm_version`, `service_version`, and `device_model`.
+      "algorithmVersion": "A String", # Output only. The algorithm version used by the feature.
+      "deviceModel": "A String", # Output only. The model name or device type of the compatible device used to collect the data.
+      "featureVersion": "A String", # Output only. The version of the feature/app running on the device.
+      "firmwareVersion": "A String", # Output only. The firmware version running on the compatible device used to collect the data.
+      "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`).
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "energyFromFat": { # Represents the energy quantity. # Optional. The energy from fat, measured in kilocalories (`kcal`).
+      "kcal": 3.14, # Required. The energy value in kilocalories.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "food": "A String", # Optional. The resource name of the Food item. Required when creating a nutrition log from an identified food. For anonymous food logs, use the `food_display_name` field instead.
+    "foodDisplayName": "A String", # The display name of the food. For identified food logs, this is populated automatically from the referenced food.
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. The time window when the food was logged.
+      "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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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).
+    },
+    "mealType": "A String", # Optional. The meal category. One of `BREAKFAST`, `LUNCH`, `DINNER`, or `SNACK`.
+    "nutrients": [ # Optional. An array of individual nutrient values for the nutrition log.
+      { # Represents the quantity of a nutrient.
+        "nutrient": "A String", # Required. The nutrient type.
+        "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams.
+          "grams": 3.14, # Required. The weight value in grams.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+      },
+    ],
+    "serving": { # Represents different properties and information about the serving of a specific food. # Optional. The serving information for the logged food.
+      "amount": 3.14, # Optional. The number of servings.
+      "foodMeasurementUnit": "A String", # Required. Food measurement unit
+      "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram").
+    },
+    "totalCarbohydrate": { # Represents the weight quantity. # Optional. The total carbohydrate content, measured in grams.
+      "grams": 3.14, # Required. The weight value in grams.
+      "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+    },
+    "totalFat": { # Represents the weight quantity. # Optional. The total fat content, measured in grams.
+      "grams": 3.14, # Required. The weight value in grams.
+      "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.
+      "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).
+    },
+  },
+  "respiratoryRateSleepSummary": { # Records respiratory rate details during sleep. Can have multiple per day if the user sleeps multiple times. # Optional. Data for points in the `respiratory-rate-sleep-summary` sample data type collection.
+    "deepSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for deep sleep.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "fullSleepStats": { # Respiratory rate statistics for a given sleep stage. # Required. Full respiratory rate statistics.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "lightSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for light sleep.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "remSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for REM sleep.
+      "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+      "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+      "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+    },
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which respiratory rate 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).
+    },
+  },
+  "runVo2Max": { # VO2 max value calculated based on the user's running activity. Value stored in ml/kg/min. # Optional. Data for points in the `run-vo2-max` sample data type collection.
+    "runVo2Max": 3.14, # Required. Run VO2 max value in ml/kg/min.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the metric 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).
+    },
+  },
+  "sedentaryPeriod": { # SedentaryPeriod SedentaryPeriod data represents the periods of time that the user was sedentary (i.e. not moving while wearing the device). # Optional. Data for points in the `sedentary-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).
+    },
+  },
+  "sleep": { # A sleep session possibly including stages. # Optional. Data for points in the `sleep` session data type collection.
+    "createTime": "A String", # Output only. Creation time of this sleep observation.
+    "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed sleep 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+        "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+        "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. The end time of the observed session.
+      "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+      "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: `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.
+      "stagesStatus": "A String", # Output only. Sleep stages algorithm processing status.
+    },
+    "outOfBedSegments": [ # Optional. “Out of bed” segments that can overlap with sleep stages.
+      { # A time interval to represent an out-of-bed segment.
+        "endTime": "A String", # Required. Segment end time.
+        "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the segment relative to the Coordinated Universal Time (UTC).
+        "startTime": "A String", # Required. Segment tart time.
+        "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the segment relative to the Coordinated Universal Time (UTC).
+      },
+    ],
+    "shortAwakenings": [ # Output only. List of short awake segments (under a set threshold) that are part of the sleep session. These can overlap with sleep stages.
+      { # Sleep stage segment.
+        "createTime": "A String", # Output only. Creation time of this sleep stages segment.
+        "endTime": "A String", # Required. Sleep stage end time.
+        "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC).
+        "startTime": "A String", # Required. Sleep stage start time.
+        "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC).
+        "type": "A String", # Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+        "updateTime": "A String", # Output only. Last update time of this sleep stages segment.
+      },
+    ],
+    "stages": [ # Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.
+      { # Sleep stage segment.
+        "createTime": "A String", # Output only. Creation time of this sleep stages segment.
+        "endTime": "A String", # Required. Sleep stage end time.
+        "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC).
+        "startTime": "A String", # Required. Sleep stage start time.
+        "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC).
+        "type": "A String", # Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+        "updateTime": "A String", # Output only. Last update time of this sleep stages segment.
+      },
+    ],
+    "summary": { #  Sleep summary: metrics and stages summary. # Output only. Sleep summary: metrics and stages summary.
+      "minutesAfterWakeUp": "A String", # Output only. Minutes after wake up calculated by restlessness algorithm.
+      "minutesAsleep": "A String", # Output only. Total number of minutes asleep. For classic sleep it is the sum of ASLEEP stages (excluding AWAKE and RESTLESS). For "stages" sleep it is the sum of LIGHT, REM and DEEP stages (excluding AWAKE).
+      "minutesAwake": "A String", # Output only. Total number of minutes awake. It is a sum of all AWAKE stages.
+      "minutesInSleepPeriod": "A String", # Output only. Delta between wake time and bedtime. It is the sum of all stages.
+      "minutesToFallAsleep": "A String", # Output only. Minutes to fall asleep calculated by restlessness algorithm.
+      "stagesSummary": [ # Output only. List of summaries (total duration and segment count) per each sleep stage type.
+        { # Total duration and segment count for a stage.
+          "count": "A String", # Output only. Number of sleep stages segments.
+          "minutes": "A String", # Output only. Total duration in minutes of a sleep stage.
+          "type": "A String", # Output only. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+        },
+      ],
+    },
+    "type": "A String", # Optional. SleepType: classic or stages.
+    "updateTime": "A String", # Output only. Last update time of this sleep observation.
+  },
+  "steps": { # Step count over the time interval. # Optional. Data for points in the `steps` interval data type collection.
+    "count": "A String", # Required. Number of steps in the recorded interval.
+    "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).
+    },
+  },
+  "swimLengthsData": { # Swim lengths data over the time interval. # Optional. Data for points in the `swim-lengths-data` 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).
+    },
+    "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.
+      "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).
+    },
+  },
+  "vo2Max": { # VO2 max measurement. # Optional. Data for points in the `vo2-max` sample data type collection.
+    "measurementMethod": "A String", # Optional. The method used to measure the VO2 max value.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which VO2 max 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).
+    },
+    "vo2Max": 3.14, # Required. VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+  },
+  "weight": { # Body weight measurement. # Optional. Data for points in the `weight` sample data type collection.
+    "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+    "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the weight 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).
+    },
+    "weightGrams": 3.14, # Required. Weight of a user in grams.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ reconcile(parent, dataSourceFamily=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Reconcile data points from multiple data sources into a single data stream.
+
+Args:
+  parent: string, Required. Parent data type of the Data Point collection. Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/heart-rate` For a list of the supported data types see the DataPoint data union field. (required)
+  dataSourceFamily: string, Optional. The data source family name to reconcile. If empty, data points from all data sources will be reconciled. Format: `users/me/dataSourceFamilies/{data_source_family}` - `users/me/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/me/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/me/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect.
+  filter: string, Optional. Filter expression based on https://aip.dev/160. A time range, either physical or civil, can be specified. See the ListDataPointsRequest.filter for the supported fields and syntax.
+  pageSize: integer, Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25.
+  pageToken: string, Optional. The `next_page_token` from a previous 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 containing the list of reconciled DataPoints.
+  "dataPoints": [ # Data points matching the query
+    { # A reconciled computed or recorded metric.
+      "activeEnergyBurned": { # Energy burned as part of an activity, excluding the basal energy burn. # Data for points in the `active-energy-burned` 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).
+        },
+        "kcal": 3.14, # Required. Energy burned during an activity, measured in kilocalories.
+      },
+      "activeMinutes": { # Record of active minutes in a given time interval. # Data for points in the `active-minutes` interval data type collection.
+        "activeMinutesByActivityLevel": [ # Required. Active minutes by activity level. At most one record per activity level is allowed.
+          { # Active minutes at a given activity level.
+            "activeMinutes": "A String", # Required. Number of whole minutes spent in activity.
+            "activityLevel": "A String", # Required. The level of activity.
+          },
+        ],
+        "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).
+        },
+      },
+      "activeZoneMinutes": { # Record of active zone minutes in a given time interval. # Data for points in the `active-zone-minutes` interval data type collection, measured in minutes.
+        "activeZoneMinutes": "A String", # Required. Number of Active Zone Minutes earned in the given time interval. Note: active_zone_minutes equals to 1 for low intensity (fat burn) zones or 2 for high intensity zones (cardio, peak).
+        "heartRateZone": "A String", # Required. Heart rate zone in which the active zone minutes have been earned, in the given time interval.
+        "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).
+        },
+      },
+      "activityLevel": { # Internal type to capture activity level during a certain time interval. # Data for points in the `activity-level` daily data type collection.
+        "activityLevelType": "A String", # Required. Activity level type in the given time interval.
+        "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).
+        },
+      },
+      "altitude": { # Captures the altitude gain (i.e. deltas), and not level above sea, for a user in millimeters. # Data for points in the `altitude` interval data type collection.
+        "gainMillimeters": "A String", # Required. Altitude gain in millimeters over the observed interval.
+        "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).
+        },
+      },
+      "basalEnergyBurned": { # Number of calories burned due to basal metabolic rate (BMR) over a period of time. # Data for points in the `basal-energy-burned` 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).
+        },
+        "kcal": 3.14, # Required. Number of calories burned due to basal metabolic rate in kilocalories over the observed interval.
+      },
+      "bloodGlucose": { # Represents a blood glucose level measurement. LINT: LEGACY_NAMES # Data for points in the `blood-glucose` sample data type collection.
+        "bloodGlucoseMilligramsPerDeciliter": 3.14, # Required. Blood glucose level concentration in mg/dL.
+        "mealType": "A String", # Optional. Meal type of the measurement.
+        "measurementSource": "A String", # Optional. Source of the measurement.
+        "measurementTiming": "A String", # Optional. Timing of the measurement.
+        "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which blood glucose 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).
+        },
+        "specimen": "A String", # Optional. Type of body fluid used to measure the blood glucose.
+      },
+      "bodyFat": { # Body fat measurement. # Data for points in the `body-fat` sample data type collection.
+        "percentage": 3.14, # Required. Body fat percentage, in range [0, 100].
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which body fat 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).
+        },
+      },
+      "coreBodyTemperature": { # Core body temperature measurement, distinct from peripheral body temperature, reflects the temperature of the body's internal organs. # Data for points in the `core-body-temperature` sample data type collection.
+        "id": "A String", # Optional. The unique identifier of the core body temperature measurement.
+        "measurementLocation": "A String", # Optional. The location of the core body temperature measurement.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which core body temperature 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).
+        },
+        "temperatureCelsius": 3.14, # Required. The core body temperature in Celsius.
+      },
+      "dailyHeartRateVariability": { # Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds` # Data for points in the `daily-heart-rate-variability` daily data type collection.
+        "averageHeartRateVariabilityMilliseconds": 3.14, # Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats.
+        "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. Date (in the user's timezone) of heart rate variability measurement.
+          "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.
+        },
+        "deepSleepRootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences (RMSSD) value during deep sleep.
+        "entropy": 3.14, # Optional. The Shanon entropy of heartbeat intervals. Entropy quantifies randomness or disorder in a system. High entropy indicates high HRV. Entropy is measured from the histogram of time interval between successive heart beats values measured during sleep.
+        "nonRemHeartRateBeatsPerMinute": "A String", # Optional. Non-REM heart rate
+      },
+      "dailyHeartRateZones": { # User's heart rate zone thresholds based on the Karvonen algorithm for a specific day. # Data for points in the `daily-heart-rate-zones` daily data type collection.
+        "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. Date (in user's timezone) of the heart rate zones record.
+          "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.
+        },
+        "heartRateZones": [ # Required. The heart rate zones.
+          { # The heart rate zone.
+            "heartRateZoneType": "A String", # Required. The heart rate zone type.
+            "maxBeatsPerMinute": "A String", # Required. Maximum heart rate for this zone in beats per minute.
+            "minBeatsPerMinute": "A String", # Required. Minimum heart rate for this zone in beats per minute.
+          },
+        ],
+      },
+      "dailyOxygenSaturation": { # A daily oxygen saturation (SpO2) record. Represents the user's daily oxygen saturation summary, typically calculated during sleep. # Data for points in the `daily-oxygen-saturation` daily data type collection.
+        "averagePercentage": 3.14, # Required. The average value of the oxygen saturation samples during the sleep.
+        "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. Date (in user's timezone) of the daily oxygen saturation record.
+          "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.
+        },
+        "lowerBoundPercentage": 3.14, # Required. The lower bound of the confidence interval of oxygen saturation samples during sleep.
+        "standardDeviationPercentage": 3.14, # Optional. Standard deviation of the daily oxygen saturation averages from the past 7-30 days.
+        "upperBoundPercentage": 3.14, # Required. The upper bound of the confidence interval of oxygen saturation samples during sleep.
+      },
+      "dailyRespiratoryRate": { # A daily average respiratory rate (breaths per minute) for a day of the year. One data point per day calculated for the main sleep. # Data for points in the `daily-respiratory-rate` daily data type collection.
+        "breathsPerMinute": 3.14, # Required. The average number of breaths taken per minute.
+        "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. The date on which the respiratory rate was measured.
+          "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.
+        },
+      },
+      "dailyRestingHeartRate": { # Measures the daily resting heart rate for a user, calculated using the all day heart rate measurements. # Data for points in the `daily-resting-heart-rate` daily data type collection.
+        "beatsPerMinute": "A String", # Required. The resting heart rate value in beats per minute.
+        "dailyRestingHeartRateMetadata": { # Metadata for the daily resting heart rate. # Optional. Metadata for the daily resting heart rate.
+          "calculationMethod": "A String", # Required. The method used to calculate the resting heart rate.
+        },
+        "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. Date (in the user's timezone) of the resting heart rate measurement.
+          "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.
+        },
+      },
+      "dailySleepTemperatureDerivations": { # Provides derived sleep temperature values, calculated from skin or internal device temperature readings during sleep. # Data for points in the `daily-sleep-temperature-derivations` daily data type collection.
+        "baselineTemperatureCelsius": 3.14, # Optional. The user's baseline skin temperature. It is the median of the user's nightly skin temperature over the past 30 days.
+        "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. Date for which the sleep temperature derivations are calculated.
+          "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.
+        },
+        "nightlyTemperatureCelsius": 3.14, # Required. The user's nightly skin temperature. It is the mean of skin temperature samples taken from the user’s sleep.
+        "relativeNightlyStddev30dCelsius": 3.14, # Optional. The standard deviation of the user’s relative nightly skin temperature (temperature - baseline) over the past 30 days.
+      },
+      "dailyVo2Max": { # Contains a daily summary of the user's VO2 max (cardio fitness score), which is the maximum rate of oxygen the body can use during exercise. # Data for points in the `daily-vo2-max` daily data type collection.
+        "cardioFitnessLevel": "A String", # Optional. Represents the user's cardio fitness level based on their VO2 max.
+        "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. The date for which the Daily VO2 max was measured.
+          "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.
+        },
+        "estimated": True or False, # Optional. An estimated field is added to indicate when the confidence has decreased sufficiently to consider the value an estimation.
+        "vo2Max": 3.14, # Required. Daily VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+        "vo2MaxCovariance": 3.14, # Optional. The covariance of the VO2 max value.
+      },
+      "dataPointName": "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.
+      "distance": { # Distance traveled over an interval of time. # Data for points in the `distance` 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).
+        },
+        "millimeters": "A String", # Required. Distance in millimeters over the observed interval.
+      },
+      "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. 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
+            "eventUtcOffset": "A String", # Required. Exercise event time offset from UTC
+            "exerciseEventType": "A String", # Required. The type of the event, such as start, stop, pause, resume.
+          },
+        ],
+        "exerciseMetadata": { # Additional exercise metadata. # Optional. Additional exercise metadata.
+          "hasGps": True or False, # Optional. Whether the exercise had GPS tracking.
+          "poolLengthMillimeters": "A String", # Optional. Pool length in millimeters. Only present in the swimming exercises.
+        },
+        "exerciseType": "A String", # Required. The type of activity performed during an exercise.
+        "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed exercise 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+            "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+            "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. The end time of the observed session.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+          "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).
+        },
+        "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this exercise ( )
+          "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+          "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+          "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+          "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+          "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+          "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+          "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+          "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+            "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+            "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+            "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+            "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+          },
+          "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+            "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+            "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+            "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+            "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+            "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+          },
+          "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+          "steps": "A String", # Optional. Total steps taken during the exercise.
+          "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+        },
+        "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+        "splitSummaries": [ # Optional. Laps or splits recorded within an exercise. Laps could be split based on distance or other criteria (duration, etc.) Laps should not be overlapping with each other.
+          { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+            "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+            "endTime": "A String", # Required. Lap end time
+            "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+            "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+              "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+              "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+              "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+              "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+              "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+              "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+              "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+              "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+                "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+                "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+                "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+                "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+              },
+              "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+                "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+                "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+                "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+                "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+                "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+              },
+              "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+              "steps": "A String", # Optional. Total steps taken during the exercise.
+              "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+            },
+            "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+            "startTime": "A String", # Required. Lap start time
+            "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+          },
+        ],
+        "splits": [ # Optional. The default split is 1 km or 1 mile. - if the movement distance is less than the default, then there are no splits - if the movement distance is greater than or equal to the default, then we have splits
+          { # Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.
+            "activeDuration": "A String", # Output only. Lap time excluding the pauses.
+            "endTime": "A String", # Required. Lap end time
+            "endUtcOffset": "A String", # Required. Lap end time offset from UTC
+            "metricsSummary": { # Summary metrics for an exercise. # Required. Summary metrics for this split.
+              "activeZoneMinutes": "A String", # Optional. Total active zone minutes for the exercise.
+              "averageHeartRateBeatsPerMinute": "A String", # Optional. Average heart rate during the exercise.
+              "averagePaceSecondsPerMeter": 3.14, # Optional. Average pace in seconds per meter.
+              "averageSpeedMillimetersPerSecond": 3.14, # Optional. Average speed in millimeters per second.
+              "caloriesKcal": 3.14, # Optional. Total calories burned by the user during the exercise.
+              "distanceMillimeters": 3.14, # Optional. Total distance covered by the user during the exercise.
+              "elevationGainMillimeters": 3.14, # Optional. Total elevation gain during the exercise.
+              "heartRateZoneDurations": { # Time spent in each heart rate zone. # Optional. Time spent in each heart rate zone.
+                "lightTime": "A String", # Optional. Time spent in light heart rate zone.
+                "moderateTime": "A String", # Optional. Time spent in moderate heart rate zone.
+                "peakTime": "A String", # Optional. Time spent in peak heart rate zone.
+                "vigorousTime": "A String", # Optional. Time spent in vigorous heart rate zone.
+              },
+              "mobilityMetrics": { # Mobility workouts specific metrics # Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.
+                "avgCadenceStepsPerMinute": 3.14, # Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.
+                "avgGroundContactTimeDuration": "A String", # Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride
+                "avgStrideLengthMillimeters": "A String", # Optional. Stride length is a measure of the distance covered by a single stride
+                "avgVerticalOscillationMillimeters": "A String", # Optional. Distance off the ground your center of mass moves with each stride while running
+                "avgVerticalRatio": 3.14, # Optional. Vertical oscillation/stride length between [5.0, 11.0].
+              },
+              "runVo2Max": 3.14, # Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.
+              "steps": "A String", # Optional. Total steps taken during the exercise.
+              "totalSwimLengths": 3.14, # Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.
+            },
+            "splitType": "A String", # Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.
+            "startTime": "A String", # Required. Lap start time
+            "startUtcOffset": "A String", # Required. Lap start time offset from UTC
+          },
+        ],
+        "updateTime": "A String", # Output only. This is the timestamp of the last update to the exercise.
+      },
+      "floors": { # Gained elevation measured in floors over the time interval # Data for points in the `floors` interval data type collection.
+        "count": "A String", # Required. Number of floors in the recorded interval
+        "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).
+        },
+      },
+      "heartRate": { # A heart rate measurement. # Data for points in the `heart-rate` sample data type collection.
+        "beatsPerMinute": "A String", # Required. The heart rate value in beats per minute.
+        "metadata": { # Heart rate metadata. # Optional. Metadata about the heart rate sample.
+          "motionContext": "A String", # Optional. Indicates the user’s level of activity when the heart rate sample was measured
+          "sensorLocation": "A String", # Optional. Indicates the location of the sensor that measured the heart rate.
+        },
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. Observation time
+          "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).
+        },
+      },
+      "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Data for points in the `heart-rate-variability` sample data type collection.
+        "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces.
+          "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz).
+          "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz).
+        },
+        "rootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time of the heart rate variability measurement.
+          "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).
+        },
+        "standardDeviationMilliseconds": 3.14, # Optional. The standard deviation of the heart rate variability measurement.
+      },
+      "height": { # Body height measurement. # Data for points in the `height` sample data type collection.
+        "heightMillimeters": "A String", # Required. Height of the user in millimeters.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the height was recorded.
+          "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).
+        },
+      },
+      "hydrationLog": { # Holds information about a user logged hydration. # Data for points in the `hydration-log` session data type collection.
+        "amountConsumed": { # Represents the volume quantity. # Required. Amount of liquid (ex. water) consumed.
+          "milliliters": 3.14, # Required. Value representing the volume in milliliters.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit, used only for user-facing input and display purposes. In the API format, all volume quantities are converted to milliliters.
+        },
+        "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+            "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+            "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. The end time of the observed session.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+          "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).
+        },
+      },
+      "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. # 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`).
+          "kcal": 3.14, # Required. The energy value in kilocalories.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+        "energyFromFat": { # Represents the energy quantity. # Optional. The energy from fat, measured in kilocalories (`kcal`).
+          "kcal": 3.14, # Required. The energy value in kilocalories.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+        "food": "A String", # Optional. The resource name of the Food item. Required when creating a nutrition log from an identified food. For anonymous food logs, use the `food_display_name` field instead.
+        "foodDisplayName": "A String", # The display name of the food. For identified food logs, this is populated automatically from the referenced food.
+        "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. The time window when the food was logged.
+          "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. Session end time in civil time in the timezone the subject is in at the end of the session.
+            "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+            "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. The end time of the observed session.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+          "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).
+        },
+        "mealType": "A String", # Optional. The meal category. One of `BREAKFAST`, `LUNCH`, `DINNER`, or `SNACK`.
+        "nutrients": [ # Optional. An array of individual nutrient values for the nutrition log.
+          { # Represents the quantity of a nutrient.
+            "nutrient": "A String", # Required. The nutrient type.
+            "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams.
+              "grams": 3.14, # Required. The weight value in grams.
+              "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+            },
+          },
+        ],
+        "serving": { # Represents different properties and information about the serving of a specific food. # Optional. The serving information for the logged food.
+          "amount": 3.14, # Optional. The number of servings.
+          "foodMeasurementUnit": "A String", # Required. Food measurement unit
+          "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram").
+        },
+        "totalCarbohydrate": { # Represents the weight quantity. # Optional. The total carbohydrate content, measured in grams.
+          "grams": 3.14, # Required. The weight value in grams.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+        "totalFat": { # Represents the weight quantity. # Optional. The total fat content, measured in grams.
+          "grams": 3.14, # Required. The weight value in grams.
+          "userProvidedUnit": "A String", # Optional. Value representing the user provided unit.
+        },
+      },
+      "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # 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.
+          "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).
+        },
+      },
+      "respiratoryRateSleepSummary": { # Records respiratory rate details during sleep. Can have multiple per day if the user sleeps multiple times. # Data for points in the `respiratory-rate-sleep-summary` sample data type collection.
+        "deepSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for deep sleep.
+          "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+          "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+          "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+        },
+        "fullSleepStats": { # Respiratory rate statistics for a given sleep stage. # Required. Full respiratory rate statistics.
+          "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+          "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+          "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+        },
+        "lightSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for light sleep.
+          "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+          "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+          "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+        },
+        "remSleepStats": { # Respiratory rate statistics for a given sleep stage. # Optional. Respiratory rate statistics for REM sleep.
+          "breathsPerMinute": 3.14, # Required. Average breaths per minute.
+          "signalToNoise": 3.14, # Optional. How trustworthy the data is for the computation.
+          "standardDeviation": 3.14, # Optional. Standard deviation of the respiratory rate during sleep.
+        },
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which respiratory rate 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).
+        },
+      },
+      "runVo2Max": { # VO2 max value calculated based on the user's running activity. Value stored in ml/kg/min. # Data for points in the `run-vo2-max` sample data type collection.
+        "runVo2Max": 3.14, # Required. Run VO2 max value in ml/kg/min.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the metric 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).
+        },
+      },
+      "sedentaryPeriod": { # SedentaryPeriod SedentaryPeriod data represents the periods of time that the user was sedentary (i.e. not moving while wearing the device). # Data for points in the `sedentary-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).
+        },
+      },
+      "sleep": { # A sleep session possibly including stages. # Data for points in the `sleep` session data type collection.
+        "createTime": "A String", # Output only. Creation time of this sleep observation.
+        "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed sleep 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. Session end time in civil time in the timezone the subject is in at the end of the session.
+            "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. Session start time in civil time in the timezone the subject is in at the start of the session.
+            "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. The end time of the observed session.
+          "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
+          "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: `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.
+          "stagesStatus": "A String", # Output only. Sleep stages algorithm processing status.
+        },
+        "outOfBedSegments": [ # Optional. “Out of bed” segments that can overlap with sleep stages.
+          { # A time interval to represent an out-of-bed segment.
+            "endTime": "A String", # Required. Segment end time.
+            "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the segment relative to the Coordinated Universal Time (UTC).
+            "startTime": "A String", # Required. Segment tart time.
+            "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the segment relative to the Coordinated Universal Time (UTC).
+          },
+        ],
+        "shortAwakenings": [ # Output only. List of short awake segments (under a set threshold) that are part of the sleep session. These can overlap with sleep stages.
+          { # Sleep stage segment.
+            "createTime": "A String", # Output only. Creation time of this sleep stages segment.
+            "endTime": "A String", # Required. Sleep stage end time.
+            "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC).
+            "startTime": "A String", # Required. Sleep stage start time.
+            "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC).
+            "type": "A String", # Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+            "updateTime": "A String", # Output only. Last update time of this sleep stages segment.
+          },
+        ],
+        "stages": [ # Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.
+          { # Sleep stage segment.
+            "createTime": "A String", # Output only. Creation time of this sleep stages segment.
+            "endTime": "A String", # Required. Sleep stage end time.
+            "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC).
+            "startTime": "A String", # Required. Sleep stage start time.
+            "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC).
+            "type": "A String", # Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+            "updateTime": "A String", # Output only. Last update time of this sleep stages segment.
+          },
+        ],
+        "summary": { #  Sleep summary: metrics and stages summary. # Output only. Sleep summary: metrics and stages summary.
+          "minutesAfterWakeUp": "A String", # Output only. Minutes after wake up calculated by restlessness algorithm.
+          "minutesAsleep": "A String", # Output only. Total number of minutes asleep. For classic sleep it is the sum of ASLEEP stages (excluding AWAKE and RESTLESS). For "stages" sleep it is the sum of LIGHT, REM and DEEP stages (excluding AWAKE).
+          "minutesAwake": "A String", # Output only. Total number of minutes awake. It is a sum of all AWAKE stages.
+          "minutesInSleepPeriod": "A String", # Output only. Delta between wake time and bedtime. It is the sum of all stages.
+          "minutesToFallAsleep": "A String", # Output only. Minutes to fall asleep calculated by restlessness algorithm.
+          "stagesSummary": [ # Output only. List of summaries (total duration and segment count) per each sleep stage type.
+            { # Total duration and segment count for a stage.
+              "count": "A String", # Output only. Number of sleep stages segments.
+              "minutes": "A String", # Output only. Total duration in minutes of a sleep stage.
+              "type": "A String", # Output only. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.
+            },
+          ],
+        },
+        "type": "A String", # Optional. SleepType: classic or stages.
+        "updateTime": "A String", # Output only. Last update time of this sleep observation.
+      },
+      "steps": { # Step count over the time interval. # Data for points in the `steps` interval data type collection.
+        "count": "A String", # Required. Number of steps in the recorded interval.
+        "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).
+        },
+      },
+      "swimLengthsData": { # Swim lengths data over the time interval. # Data for points in the `swim-lengths-data` 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).
+        },
+        "strokeCount": "A String", # Required. Number of strokes in the lap.
+        "swimStrokeType": "A String", # Required. Swim stroke type.
+      },
+      "timeInHeartRateZone": { # Time in heart rate zone record. It's an interval spent in specific heart rate zone. # 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.
+          "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).
+        },
+      },
+      "vo2Max": { # VO2 max measurement. # Data for points in the `vo2-max` sample data type collection.
+        "measurementMethod": "A String", # Optional. The method used to measure the VO2 max value.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which VO2 max 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).
+        },
+        "vo2Max": 3.14, # Required. VO2 max value measured as in ml consumed oxygen / kg of body weight / min.
+      },
+      "weight": { # Body weight measurement. # Data for points in the `weight` sample data type collection.
+        "notes": "A String", # Optional. Standard free-form notes captured at manual logging.
+        "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which the weight 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).
+        },
+        "weightGrams": 3.14, # Required. Weight of a user in grams.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Next page token, empty if the response is complete
+}
+
+ +
+ reconcile_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ rollUp(parent, body=None, x__xgafv=None) +
Roll up data points over physical time intervals for supported data types.
+
+Args:
+  parent: string, Required. Parent data type of the Data Point collection. Format: `users/{user}/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/distance` For a list of the supported data types see the RollupDataPoint value union field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to roll up data points by physical time intervals.
+  "dataSourceFamily": "A String", # Optional. The data source family name to roll up. If empty, data points from all available data sources will be rolled up. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/me/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/me/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect.
+  "pageSize": 42, # Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly.
+  "pageToken": "A String", # Optional. The next_page_token from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.
+  "range": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Required. Closed-open range of data points that will be rolled up. The maximum range for `calories-in-heart-rate-zone`, `heart-rate`, `active-minutes` and `total-calories` is 14 days. The maximum range for all other data types is 90 days.
+    "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+    "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+  },
+  "windowSize": "A String", # Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second. If the requested range is not an exact multiple of `window_size`, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than `window_size`.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response containing the list of rolled up data points.
+  "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.
+  "rollupDataPoints": [ # Values for each aggregation time window.
+    { # Value of a rollup for a single physical time interval (aggregation window) of reconciled data points from all data sources, excluding those data points that are identified as recorded by wearables in intervals when they were not actually worn.
+      "activeEnergyBurned": { # Represents the result of the rollup of active energy burned. # Returned by default when rolling up data points from the `active-energy-burned` data type.
+        "kcalSum": 3.14, # Output only. Sum of the active energy burned in kilocalories.
+      },
+      "activeMinutes": { # Represents the result of the rollup of the active minutes data type. # Returned by default when rolling up data points from the `active-minutes` data type, or when requested explicitly using the `active-minutes` rollup type identifier.
+        "activeMinutesRollupByActivityLevel": [ # Active minutes by activity level. At most one record per activity level is allowed.
+          { # Active minutes by activity level.
+            "activeMinutesSum": "A String", # Number of whole minutes spent in activity.
+            "activityLevel": "A String", # The level of activity.
+          },
+        ],
+      },
+      "activeZoneMinutes": { # Represents the result of the rollup of the active zone minutes data type. # Returned by default when rolling up data points from the `active-zone-minutes` data type, or when requested explicitly using the `active-zone-minutes` rollup type identifier.
+        "sumInCardioHeartZone": "A String", # Active zone minutes in `HeartRateZone.CARDIO`.
+        "sumInFatBurnHeartZone": "A String", # Active zone minutes in `HeartRateZone.FAT_BURN`.
+        "sumInPeakHeartZone": "A String", # Active zone minutes in `HeartRateZone.PEAK`.
+      },
+      "activityLevel": { # Represents the result of the rollup of the activity level data type. # Returned by default when rolling up data points from the `activity-level` data type, or when requested explicitly using the `activity-level` rollup type identifier.
+        "activityLevelRollupsByActivityLevelType": [ # List of total durations in each activity level type.
+          { # Represents the total duration in a specific activity level type.
+            "activityLevelType": "A String", # Activity level type.
+            "totalDuration": "A String", # Total duration in the activity level type.
+          },
+        ],
+      },
+      "altitude": { # Represents the result of the rollup of the user's altitude. # Returned by default when rolling up data points from the `altitude` data type, or when requested explicitly using the `altitude` rollup type identifier.
+        "gainMillimetersSum": "A String", # Sum of the altitude gain in millimeters.
+      },
+      "bloodGlucose": { # Represents the result of the rollup of the blood glucose data type. LINT: LEGACY_NAMES # Returned by default when rolling up data points from the `blood-glucose` data type.
+        "bloodGlucoseMilligramsPerDeciliterAvg": 3.14, # Average blood glucose level in mg/dL.
+      },
+      "bodyFat": { # Represents the result of the rollup of the body fat data type. # Returned by default when rolling up data points from the `body-fat` data type, or when requested explicitly using the `body-fat` rollup type identifier.
+        "bodyFatPercentageAvg": 3.14, # Average body fat percentage.
+      },
+      "caloriesInHeartRateZone": { # Represents the result of the rollup of the calories in heart rate zone data type. # Returned by default when rolling up data points from the `calories-in-heart-rate-zone` data type, or when requested explicitly using the `calories-in-heart-rate-zone` rollup type identifier.
+        "caloriesInHeartRateZones": [ # List of calories burned in each heart rate zone.
+          { # Represents the amount of kilocalories burned in a specific heart rate zone.
+            "heartRateZone": "A String", # The heart rate zone.
+            "kcal": 3.14, # The amount of kilocalories burned in the specified heart rate zone.
+          },
+        ],
+      },
+      "coreBodyTemperature": { # Represents the result of the rollup of the core body temperature data type. # Returned by default when rolling up data points from the `core-body-temperature` data type, or when requested explicitly using the `core-body-temperature` rollup type identifier.
+        "temperatureCelsiusAvg": 3.14, # Average core body temperature in Celsius.
+        "temperatureCelsiusMax": 3.14, # Maximum core body temperature in Celsius.
+        "temperatureCelsiusMin": 3.14, # Minimum core body temperature in Celsius.
+      },
+      "distance": { # Result of the rollup of the user's distance. # Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier.
+        "millimetersSum": "A String", # Sum of the distance in millimeters.
+      },
+      "endTime": "A String", # End time of the window this value aggregates over
+      "floors": { # Represents the result of the rollup of the user's floors. # Returned by default when rolling up data points from the `floors` data type, or when requested explicitly using the `floors` rollup type identifier.
+        "countSum": "A String", # Sum of the floors count.
+      },
+      "heartRate": { # Represents the result of the rollup of the heart rate data type. # Returned by default when rolling up data points from the `heart-rate` data type, or when requested explicitly using the `heart-rate` rollup type identifier.
+        "beatsPerMinuteAvg": 3.14, # The average heart rate value in the interval.
+        "beatsPerMinuteMax": 3.14, # The maximum heart rate value in the interval.
+        "beatsPerMinuteMin": 3.14, # The minimum heart rate value in the interval.
+      },
+      "hydrationLog": { # Represents the result of the rollup of the hydration log data type. # Returned by default when rolling up data points from the `hydration-log` data type, or when requested explicitly using the `hydration-log` rollup type identifier.
+        "amountConsumed": { # Rollup for volume quantity. # Rollup for amount consumed.
+          "millilitersSum": 3.14, # Required. The sum of volume in milliliters.
+          "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element.
+        },
+      },
+      "nutritionLog": { # Represents the result of the rollup of the nutrition log data type. # Returned by default when rolling up data points from the `nutrition-log` data type, or when requested explicitly using the `nutrition-log` rollup type identifier.
+        "energy": { # Rollup for the energy quantity. # Energy rollup.
+          "kcalSum": 3.14, # Required. The sum of the energy in kilocalories.
+          "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element.
+        },
+        "energyFromFat": { # Rollup for the energy quantity. # Value Energy from fat rollup.
+          "kcalSum": 3.14, # Required. The sum of the energy in kilocalories.
+          "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element.
+        },
+        "nutrients": [ # List of the nutrient roll-ups by the nutrient type.
+          { # Nutrient quantity rollup.
+            "nutrient": "A String", # Required. Aggregated nutrient.
+            "quantity": { # Rollup for the weight. # Required. Aggregated nutrient weight.
+              "gramsSum": 3.14, # Required. The sum of the weight in grams.
+              "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element.
+            },
+          },
+        ],
+        "totalCarbohydrate": { # Rollup for the weight. # Total carbohydrate rollup.
+          "gramsSum": 3.14, # Required. The sum of the weight in grams.
+          "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element.
+        },
+        "totalFat": { # Rollup for the weight. # Total fat rollup.
+          "gramsSum": 3.14, # Required. The sum of the weight in grams.
+          "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element.
+        },
+      },
+      "runVo2Max": { # Represents the result of the rollup of the user's daily heart rate variability personal range. # Returned by default when rolling up data points from the `run-vo2-max` data type, or when requested explicitly using the `run-vo2-max` rollup type identifier.
+        "rateAvg": 3.14, # Average value of run VO2 max in the interval.
+        "rateMax": 3.14, # Maximum value of run VO2 max in the interval.
+        "rateMin": 3.14, # Minimum value of run VO2 max in the interval..
+      },
+      "sedentaryPeriod": { # Represents the result of the rollup of the user's sedentary periods. # Returned by default when rolling up data points from the `sedentary-period` data type, or when requested explicitly using the `sedentary-period` rollup type identifier.
+        "durationSum": "A String", # The total time user spent sedentary during the interval.
+      },
+      "startTime": "A String", # Start time of the window this value aggregates over
+      "steps": { # Represents the result of the rollup of the steps data type. # Returned by default when rolling up data points from the `steps` data type, or when requested explicitly using the `steps` rollup type identifier.
+        "countSum": "A String", # Total number of steps in the interval.
+      },
+      "swimLengthsData": { # Represents the result of the rollup of the swim lengths data type. # Returned by default when rolling up data points from the `swim-lengths-data` data type, or when requested explicitly using the `swim-lengths-data` rollup type identifier.
+        "strokeCountSum": "A String", # Total number of swim strokes in the interval.
+      },
+      "timeInHeartRateZone": { # Represents the result of the rollup of the time in heart rate zone data type. # Returned by default when rolling up data points from the `time-in-heart-rate-zone` data type, or when requested explicitly using the `time-in-heart-rate-zone` rollup type identifier.
+        "timeInHeartRateZones": [ # List of time spent in each heart rate zone.
+          { # Represents the total time spent in a specific heart rate zone.
+            "duration": "A String", # The total time spent in the specified heart rate zone.
+            "heartRateZone": "A String", # The heart rate zone.
+          },
+        ],
+      },
+      "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.
+        "weightGramsAvg": 3.14, # Average weight in grams.
+      },
+    },
+  ],
+}
+
+ +
+ rollUp_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/health_v4beta.users.dataTypes.html b/docs/dyn/health_v4beta.users.dataTypes.html new file mode 100644 index 0000000000..a884c7364e --- /dev/null +++ b/docs/dyn/health_v4beta.users.dataTypes.html @@ -0,0 +1,91 @@ + + + +

Google Health API . users . dataTypes

+

Instance Methods

+

+ dataPoints() +

+

Returns the dataPoints Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/health_v4beta.users.html b/docs/dyn/health_v4beta.users.html new file mode 100644 index 0000000000..81182898c4 --- /dev/null +++ b/docs/dyn/health_v4beta.users.html @@ -0,0 +1,321 @@ + + + +

Google Health API . users

+

Instance Methods

+

+ dataTypes() +

+

Returns the dataTypes Resource.

+ +

+ pairedDevices() +

+

Returns the pairedDevices Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ getIdentity(name, x__xgafv=None)

+

Gets the user's identity. It includes the legacy Fitbit user ID and the Google user ID and it can be used by migrating clients to map identifiers between the two systems.

+

+ getIrnProfile(name, x__xgafv=None)

+

Returns user's IRN Profile details.

+

+ getProfile(name, x__xgafv=None)

+

Returns user Profile details.

+

+ getSettings(name, x__xgafv=None)

+

Returns user settings details.

+

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

+

Updates the user's profile details.

+

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

+

Updates the user's settings details.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getIdentity(name, x__xgafv=None) +
Gets the user's identity. It includes the legacy Fitbit user ID and the Google user ID and it can be used by migrating clients to map identifiers between the two systems.
+
+Args:
+  name: string, Required. The resource name of the Identity. Format: `users/me/identity` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents details about the Google user's identity.
+  "healthUserId": "A String", # Output only. The Google User Identifier in the Google Health APIs. It matches the `{user}` resource ID segment in the resource name paths, e.g. `users/{user}/dataTypes/steps`. Valid values are strings of 1-63 characters, and valid characters are lowercase and uppercase letters, numbers, and hyphens.
+  "legacyUserId": "A String", # Output only. The legacy Fitbit User identifier. This is the Fitbit ID used in the legacy Fitbit APIs (v1-v3). It can be referenced by clients migrating from the legacy Fitbit APIs to map their existing identifiers to the new Google user ID. It **must not** be used for any other purpose. It is not of any use for new clients using only the Google Health APIs. Valid values are strings of 1-63 characters, and valid characters are lowercase and uppercase letters, numbers, and hyphens.
+  "name": "A String", # Identifier. The resource name of this Identity resource. Format: `users/me/identity`
+}
+
+ +
+ getIrnProfile(name, x__xgafv=None) +
Returns user's IRN Profile details.
+
+Args:
+  name: string, Required. The resource name of the IRN Profile. Format: `users/{user}/irnProfile` Example: `users/1234567890/irnProfile` or `users/me/irnProfile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Irregular Rhythm Notifications (IRN) Profile details. The Irregular Rhythm Notifications (IRN) feature checks for signs of atrial fibrillation (AFib). The IrnProfile details include information about the user's onboarding status, enrollment status, and the last update time of analyzable data for this feature.
+  "enrollmentStatus": True or False, # Required. Whether or not the user is currently enrolled in having their data processed for IRN alerts.
+  "name": "A String", # Identifier. The resource name of this IrnProfile resource. Format: `users/{user}/irnProfile` Example: `users/1234567890/irnProfile` or `users/me/irnProfile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
+  "onboardingStatus": True or False, # Required. Whether or not the user has onboarded onto the IRN feature.
+  "updateTime": "A String", # Output only. The timestamp of the last piece of analyzable data synced by the user.
+}
+
+ +
+ getProfile(name, x__xgafv=None) +
Returns user Profile details.
+
+Args:
+  name: string, Required. The name of the Profile. Format: `users/me/profile`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Profile details.
+  "age": 42, # Optional. The age in years based on the user's birth date. Updates to this field are currently not supported.
+  "autoRunningStrideLengthMm": 42, # Output only. The automatically calculated running stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`
+  "autoWalkingStrideLengthMm": 42, # Output only. The automatically calculated walking stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`
+  "membershipStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date the user created their account. Updates to this field are currently not supported.
+    "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.
+  },
+  "name": "A String", # Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
+  "userConfiguredRunningStrideLengthMm": 42, # Optional. The user's user configured running stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`
+  "userConfiguredWalkingStrideLengthMm": 42, # Optional. The user's user configured walking stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`
+}
+
+ +
+ getSettings(name, x__xgafv=None) +
Returns user settings details.
+
+Args:
+  name: string, Required. The name of the Settings. Format: `users/me/settings`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Settings details.
+  "autoStrideEnabled": True or False, # Optional. True if the user's stride length is determined automatically. Updates to this field are currently not supported.
+  "distanceUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "foodLanguageCode": "A String", # Output only. The food language code derived from the user's food database. Possible values: `'en-US'`, `'en-GB'`, `'de-DE'`, `'es-ES'`, `'fr-FR'`, `'zh-CN'`, `'zh-TW'`, `'ja-JP'`, `'en-AU'`, `'en-CA'`, `'it-IT'`, `'ko-KR'`, `'es-MX'`, `'en-IN'`, `'en-SG'`, `'en-PH'`, `'en-IE'`, `'fr-CA'`. Updates to this field are currently not supported.
+  "glucoseUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "heightUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "languageLocale": "A String", # Optional. The locale defined in the user's account settings. Updates to this field are currently not supported.
+  "name": "A String", # Identifier. The resource name of this Settings resource. Format: `users/{user}/settings` Example: `users/1234567890/settings` or `users/me/settings` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
+  "strideLengthRunningType": "A String", # Optional. The stride length type defined in the user's account settings for running. Updates to this field are currently not supported.
+  "strideLengthWalkingType": "A String", # Optional. The stride length type defined in the user's account settings for walking. Updates to this field are currently not supported.
+  "swimUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "temperatureUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "timeZone": "A String", # Optional. The timezone defined in the user's account settings. This follows the IANA [Time Zone Database](https://www.iana.org/time-zones). Updates to this field are currently not supported.
+  "utcOffset": "A String", # Optional. The user's timezone offset relative to UTC. Updates to this field are currently not supported.
+  "waterUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "weightUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+}
+
+ +
+ updateProfile(name, body=None, updateMask=None, x__xgafv=None) +
Updates the user's profile details.
+
+Args:
+  name: string, Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Profile details.
+  "age": 42, # Optional. The age in years based on the user's birth date. Updates to this field are currently not supported.
+  "autoRunningStrideLengthMm": 42, # Output only. The automatically calculated running stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`
+  "autoWalkingStrideLengthMm": 42, # Output only. The automatically calculated walking stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`
+  "membershipStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date the user created their account. Updates to this field are currently not supported.
+    "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.
+  },
+  "name": "A String", # Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
+  "userConfiguredRunningStrideLengthMm": 42, # Optional. The user's user configured running stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`
+  "userConfiguredWalkingStrideLengthMm": 42, # Optional. The user's user configured walking stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`
+}
+
+  updateMask: string, Optional. The list of fields to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Profile details.
+  "age": 42, # Optional. The age in years based on the user's birth date. Updates to this field are currently not supported.
+  "autoRunningStrideLengthMm": 42, # Output only. The automatically calculated running stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`
+  "autoWalkingStrideLengthMm": 42, # Output only. The automatically calculated walking stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`
+  "membershipStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date the user created their account. Updates to this field are currently not supported.
+    "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.
+  },
+  "name": "A String", # Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
+  "userConfiguredRunningStrideLengthMm": 42, # Optional. The user's user configured running stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`
+  "userConfiguredWalkingStrideLengthMm": 42, # Optional. The user's user configured walking stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`
+}
+
+ +
+ updateSettings(name, body=None, updateMask=None, x__xgafv=None) +
Updates the user's settings details.
+
+Args:
+  name: string, Identifier. The resource name of this Settings resource. Format: `users/{user}/settings` Example: `users/1234567890/settings` or `users/me/settings` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Settings details.
+  "autoStrideEnabled": True or False, # Optional. True if the user's stride length is determined automatically. Updates to this field are currently not supported.
+  "distanceUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "foodLanguageCode": "A String", # Output only. The food language code derived from the user's food database. Possible values: `'en-US'`, `'en-GB'`, `'de-DE'`, `'es-ES'`, `'fr-FR'`, `'zh-CN'`, `'zh-TW'`, `'ja-JP'`, `'en-AU'`, `'en-CA'`, `'it-IT'`, `'ko-KR'`, `'es-MX'`, `'en-IN'`, `'en-SG'`, `'en-PH'`, `'en-IE'`, `'fr-CA'`. Updates to this field are currently not supported.
+  "glucoseUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "heightUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "languageLocale": "A String", # Optional. The locale defined in the user's account settings. Updates to this field are currently not supported.
+  "name": "A String", # Identifier. The resource name of this Settings resource. Format: `users/{user}/settings` Example: `users/1234567890/settings` or `users/me/settings` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
+  "strideLengthRunningType": "A String", # Optional. The stride length type defined in the user's account settings for running. Updates to this field are currently not supported.
+  "strideLengthWalkingType": "A String", # Optional. The stride length type defined in the user's account settings for walking. Updates to this field are currently not supported.
+  "swimUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "temperatureUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "timeZone": "A String", # Optional. The timezone defined in the user's account settings. This follows the IANA [Time Zone Database](https://www.iana.org/time-zones). Updates to this field are currently not supported.
+  "utcOffset": "A String", # Optional. The user's timezone offset relative to UTC. Updates to this field are currently not supported.
+  "waterUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "weightUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+}
+
+  updateMask: string, Optional. The list of fields to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Settings details.
+  "autoStrideEnabled": True or False, # Optional. True if the user's stride length is determined automatically. Updates to this field are currently not supported.
+  "distanceUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "foodLanguageCode": "A String", # Output only. The food language code derived from the user's food database. Possible values: `'en-US'`, `'en-GB'`, `'de-DE'`, `'es-ES'`, `'fr-FR'`, `'zh-CN'`, `'zh-TW'`, `'ja-JP'`, `'en-AU'`, `'en-CA'`, `'it-IT'`, `'ko-KR'`, `'es-MX'`, `'en-IN'`, `'en-SG'`, `'en-PH'`, `'en-IE'`, `'fr-CA'`. Updates to this field are currently not supported.
+  "glucoseUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "heightUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "languageLocale": "A String", # Optional. The locale defined in the user's account settings. Updates to this field are currently not supported.
+  "name": "A String", # Identifier. The resource name of this Settings resource. Format: `users/{user}/settings` Example: `users/1234567890/settings` or `users/me/settings` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
+  "strideLengthRunningType": "A String", # Optional. The stride length type defined in the user's account settings for running. Updates to this field are currently not supported.
+  "strideLengthWalkingType": "A String", # Optional. The stride length type defined in the user's account settings for walking. Updates to this field are currently not supported.
+  "swimUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "temperatureUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "timeZone": "A String", # Optional. The timezone defined in the user's account settings. This follows the IANA [Time Zone Database](https://www.iana.org/time-zones). Updates to this field are currently not supported.
+  "utcOffset": "A String", # Optional. The user's timezone offset relative to UTC. Updates to this field are currently not supported.
+  "waterUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+  "weightUnit": "A String", # Optional. The measurement unit defined in the user's account settings.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/health_v4beta.users.pairedDevices.html b/docs/dyn/health_v4beta.users.pairedDevices.html new file mode 100644 index 0000000000..05c991fb36 --- /dev/null +++ b/docs/dyn/health_v4beta.users.pairedDevices.html @@ -0,0 +1,172 @@ + + + +

Google Health API . users . pairedDevices

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Returns user's Device.

+

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

+

Returns the user's list of paired 1P trackers and smartwatches.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Returns user's Device.
+
+Args:
+  name: string, Required. The name of the device to retrieve. Format: users/{user}/devices/{device} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # User's Paired 1P Device The PairedDevice details include information about the device type, battery status, battery level, last sync time, device version, mac address, and features.
+  "batteryLevel": 42, # Output only. The battery level of the device.
+  "batteryStatus": "A String", # Output only. The battery status of the device. Supported: High | Medium | Low | Empty
+  "deviceType": "A String", # Output only. The device type. Supported: TRACKER | SCALE
+  "deviceVersion": "A String", # Output only. The product name of the device
+  "features": [ # Output only. Lists of unique features supported by the device. Comprehensive list of supported features: **Fitness Tracking** - `ACTIVE_MINUTES`: Legacy active minutes. - `AUTOSTRIDE`: Automatic stride length calculation. - `BIKE_ONBOARDING`: Cycling UI support. - `CALORIES`: Daily burned calories. - `DISTANCE`: Daily distance tracking. - `ELEVATION`: Floors climbed. - `INACTIVITY_ALERTS`: Reminders to move. - `SEDENTARY_TIME`: Tracks inactive time. - `STEPS`: Daily steps. - `SWIM`: Swim tracking (laps/strokes). - `AUTORUN`: Automatic run detection. - `ACTIVE_ZONE_MINUTES`: Active Zone Minutes (AZM). **Heart Rate & Health** - `HEART_RATE`: Continuous heart rate (PPG). - `BAT_SIGNAL`: High/Low Heart Rate Alerts. **Advanced Sensors** - `SPO2`: Blood oxygen saturation. - `NIGHTTIME_OXYGEN_SATURATION`: Sleep SpO2. - `ESTIMATED_OXYGEN_VARIATION`: Estimated Oxygen Variation. - `EDA`: Electrodermal Activity (stress). - `SKIN_TEMPERATURE`: Skin temperature variation. - `INTERNAL_DEVICE_TEMPERATURE`: Internal device temperature. **Sleep & Wellness** - `SLEEP`: Basic sleep tracking. - `SMART_SLEEP`: Advanced sleep tracking (stages/score). - `BEDTIME_REMINDER`: Bedtime reminders. - `SOUNDSCAPE`: Snore and noise detection. **Advanced Workouts** - `WB`: Custom Workout Builder. - `AUTOCUES`: Auto Cues / Auto Lap. - `DWR_RUN`: Daily Run Recommendations. - `ADVANCED_RUNNING`: Advanced Running Dynamics (e.g., GCT, VO). **GPS & Location** - `GPS`: Built-in GPS. - `CONNECTED_GPS`: Connected GPS (uses phone). - `LOCATION_HINT`: Location helper. **Payments & NFC** - `PAYMENTS`: NFC payments (Fitbit Pay/Google Wallet). - `FELICA`: FeliCa support (Japan payments/transit). **Activity Detection** - `GROK`: SmartTrack automatic activity detection. - `RETRO_AR`: Retroactive Activity Recognition prompts. **Smart Features & UI** - `ALARMS`: Silent alarms. - `BLE_MUSIC_CONTROL`: BLE music control. - `MUSIC`: Direct music storage/control. - `YOUTUBE_MUSIC_SUPPORTED`: YouTube Music support. - `GALLERY`: App Gallery. - `TUTORIAL_SUPPORTED`: On-screen tutorials. - `SMILEY_EMOTE`: Legacy Zip face. - `MOBILE_TO_DEVICE_DEEPLINK`: Mobile to device settings deep link. - `HIDE_GALLERY`: Option to hide Gallery. - `HIDE_GOAL_SELECTION`: Option to hide goal selection. - `DIGITAL_WARRANTY_SUPPORTED`: Digital warranty display. - `DIRECT_DEVICE_SETTINGS_SUPPORTED`: Direct device settings management. **Gym HR Broadcasting** - `ASPEN_SUPPORTED`: Broadcast HR to gym equipment. - `ASPEN_REMOTE_UI_SUPPORTED`: Remote UI for HR sharing. **Privacy & Security** - `FINITE_IMPROBABILITY`: BLE Resolvable Private Address (RPA) privacy. - `DOMAIN_KEY_SYNC`: Domain key synchronization. **BLE Protocol** - `BONDING`: Secure BLE bonding. - `ADVERTISES_SERIAL`: Advertises serial number. - `STATUS_CHARACTERISTIC`: BLE Status Characteristic. - `TRACKER_CHANNEL_CHARACTERISTIC`: BLE Tracker Channel Characteristic. - `PING_CHARACTERISTIC`: BLE Ping Characteristic. **Cellular & Wi-Fi** - `MOBILE_DATA`: LTE cellular support. - `SINGLE_AP_WIFI`: Single AP Wi-Fi. - `MULTI_AP_WIFI`: Multi AP Wi-Fi. - `WIFI_FWUP`: Firmware updates over Wi-Fi. **Data Sync & Transfer** - `APP_SYNC`: Background app sync. - `LIVE_DATA`: Real-time data streaming. - `EVENT_BASED_SYNC_SUPPORTED`: Event-based sync. - `TIME_SERVICE`: Time synchronization service. - `REMOTE_FILE_PROVIDER`: Remote file transfer. - `DIRECT_COMMS_ALARMS`: Direct communication for alarms. - `DIRECT_COMMS_EXERCISE`: Direct communication for exercise. - `DIRECT_COMMS_BATTERY_ALERTS`: Direct communication for battery alerts. **Google Integrations** - `PARROT_TREE_SUPPORTED`: Find My Device support.
+    "A String",
+  ],
+  "lastSyncTime": "A String", # Output only. The time of last sync with the Fitbit mobile application.
+  "macAddress": "A String", # Output only. Mac ID number of the device.
+  "name": "A String", # Identifier. The resource name of this Device resource. Format: `users/{user}/pairedDevices/{paired_device}` Example: `users/1234567890/pairedDevices/123` or `users/me/pairedDevices/123`
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Returns the user's list of paired 1P trackers and smartwatches.
+
+Args:
+  parent: string, Required. The parent, which owns this collection of devices. Format: users/{user} (required)
+  pageSize: integer, Optional. The maximum number of devices to return. The service may return fewer than this value. If unspecified, at most 5 devices will be returned. The maximum value is 100. values above 100 will be coerced to 100.
+  pageToken: string, Optional. A page token, received from a previous `ListPairedDevices` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPairedDevices` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListPairedDevices.
+  "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.
+  "pairedDevices": [ # The paired devices of the user.
+    { # User's Paired 1P Device The PairedDevice details include information about the device type, battery status, battery level, last sync time, device version, mac address, and features.
+      "batteryLevel": 42, # Output only. The battery level of the device.
+      "batteryStatus": "A String", # Output only. The battery status of the device. Supported: High | Medium | Low | Empty
+      "deviceType": "A String", # Output only. The device type. Supported: TRACKER | SCALE
+      "deviceVersion": "A String", # Output only. The product name of the device
+      "features": [ # Output only. Lists of unique features supported by the device. Comprehensive list of supported features: **Fitness Tracking** - `ACTIVE_MINUTES`: Legacy active minutes. - `AUTOSTRIDE`: Automatic stride length calculation. - `BIKE_ONBOARDING`: Cycling UI support. - `CALORIES`: Daily burned calories. - `DISTANCE`: Daily distance tracking. - `ELEVATION`: Floors climbed. - `INACTIVITY_ALERTS`: Reminders to move. - `SEDENTARY_TIME`: Tracks inactive time. - `STEPS`: Daily steps. - `SWIM`: Swim tracking (laps/strokes). - `AUTORUN`: Automatic run detection. - `ACTIVE_ZONE_MINUTES`: Active Zone Minutes (AZM). **Heart Rate & Health** - `HEART_RATE`: Continuous heart rate (PPG). - `BAT_SIGNAL`: High/Low Heart Rate Alerts. **Advanced Sensors** - `SPO2`: Blood oxygen saturation. - `NIGHTTIME_OXYGEN_SATURATION`: Sleep SpO2. - `ESTIMATED_OXYGEN_VARIATION`: Estimated Oxygen Variation. - `EDA`: Electrodermal Activity (stress). - `SKIN_TEMPERATURE`: Skin temperature variation. - `INTERNAL_DEVICE_TEMPERATURE`: Internal device temperature. **Sleep & Wellness** - `SLEEP`: Basic sleep tracking. - `SMART_SLEEP`: Advanced sleep tracking (stages/score). - `BEDTIME_REMINDER`: Bedtime reminders. - `SOUNDSCAPE`: Snore and noise detection. **Advanced Workouts** - `WB`: Custom Workout Builder. - `AUTOCUES`: Auto Cues / Auto Lap. - `DWR_RUN`: Daily Run Recommendations. - `ADVANCED_RUNNING`: Advanced Running Dynamics (e.g., GCT, VO). **GPS & Location** - `GPS`: Built-in GPS. - `CONNECTED_GPS`: Connected GPS (uses phone). - `LOCATION_HINT`: Location helper. **Payments & NFC** - `PAYMENTS`: NFC payments (Fitbit Pay/Google Wallet). - `FELICA`: FeliCa support (Japan payments/transit). **Activity Detection** - `GROK`: SmartTrack automatic activity detection. - `RETRO_AR`: Retroactive Activity Recognition prompts. **Smart Features & UI** - `ALARMS`: Silent alarms. - `BLE_MUSIC_CONTROL`: BLE music control. - `MUSIC`: Direct music storage/control. - `YOUTUBE_MUSIC_SUPPORTED`: YouTube Music support. - `GALLERY`: App Gallery. - `TUTORIAL_SUPPORTED`: On-screen tutorials. - `SMILEY_EMOTE`: Legacy Zip face. - `MOBILE_TO_DEVICE_DEEPLINK`: Mobile to device settings deep link. - `HIDE_GALLERY`: Option to hide Gallery. - `HIDE_GOAL_SELECTION`: Option to hide goal selection. - `DIGITAL_WARRANTY_SUPPORTED`: Digital warranty display. - `DIRECT_DEVICE_SETTINGS_SUPPORTED`: Direct device settings management. **Gym HR Broadcasting** - `ASPEN_SUPPORTED`: Broadcast HR to gym equipment. - `ASPEN_REMOTE_UI_SUPPORTED`: Remote UI for HR sharing. **Privacy & Security** - `FINITE_IMPROBABILITY`: BLE Resolvable Private Address (RPA) privacy. - `DOMAIN_KEY_SYNC`: Domain key synchronization. **BLE Protocol** - `BONDING`: Secure BLE bonding. - `ADVERTISES_SERIAL`: Advertises serial number. - `STATUS_CHARACTERISTIC`: BLE Status Characteristic. - `TRACKER_CHANNEL_CHARACTERISTIC`: BLE Tracker Channel Characteristic. - `PING_CHARACTERISTIC`: BLE Ping Characteristic. **Cellular & Wi-Fi** - `MOBILE_DATA`: LTE cellular support. - `SINGLE_AP_WIFI`: Single AP Wi-Fi. - `MULTI_AP_WIFI`: Multi AP Wi-Fi. - `WIFI_FWUP`: Firmware updates over Wi-Fi. **Data Sync & Transfer** - `APP_SYNC`: Background app sync. - `LIVE_DATA`: Real-time data streaming. - `EVENT_BASED_SYNC_SUPPORTED`: Event-based sync. - `TIME_SERVICE`: Time synchronization service. - `REMOTE_FILE_PROVIDER`: Remote file transfer. - `DIRECT_COMMS_ALARMS`: Direct communication for alarms. - `DIRECT_COMMS_EXERCISE`: Direct communication for exercise. - `DIRECT_COMMS_BATTERY_ALERTS`: Direct communication for battery alerts. **Google Integrations** - `PARROT_TREE_SUPPORTED`: Find My Device support.
+        "A String",
+      ],
+      "lastSyncTime": "A String", # Output only. The time of last sync with the Fitbit mobile application.
+      "macAddress": "A String", # Output only. Mac ID number of the device.
+      "name": "A String", # Identifier. The resource name of this Device resource. Format: `users/{user}/pairedDevices/{paired_device}` Example: `users/1234567890/pairedDevices/123` or `users/me/pairedDevices/123`
+    },
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/health.v4.json b/googleapiclient/discovery_cache/documents/health.v4.json index dff829c9ac..cd173cfb35 100644 --- a/googleapiclient/discovery_cache/documents/health.v4.json +++ b/googleapiclient/discovery_cache/documents/health.v4.json @@ -1134,7 +1134,7 @@ } } }, -"revision": "20260904", +"revision": "20260908", "rootUrl": "https://health.googleapis.com/", "schemas": { "ActiveEnergyBurned": { @@ -3468,6 +3468,39 @@ }, "type": "object" }, +"GoogleDevicesandservicesHealthV4betaDataType": { +"description": "Represents a type of health data a user can have data points recorded for. It matches the parent resource of collection containing data points of the given type. Clients currently do not need to interact with this resource directly.", +"id": "GoogleDevicesandservicesHealthV4betaDataType", +"properties": { +"name": { +"description": "Identifier. The resource name of the data type. Format: `users/{user}/dataTypes/{data_type}` See DataPoint.name for examples and possible values.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleDevicesandservicesHealthV4betaUser": { +"description": "Represents a user in the Google Health API. It matches the parent resource of collections owned by the user. Clients currently do not need to interact with this resource directly.", +"id": "GoogleDevicesandservicesHealthV4betaUser", +"properties": { +"name": { +"description": "Identifier. The resource name of the user. The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. Format: `users/{user}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleDevicesandservicesHealthV4betaWebhookNotificationCloudLog": { +"description": "Log message for a webhook notification sent by the Google Health API to a subscriber's endpoint. Includes the HTTP response received from the endpoint.", +"id": "GoogleDevicesandservicesHealthV4betaWebhookNotificationCloudLog", +"properties": { +"httpResponse": { +"$ref": "HttpResponse", +"description": "Required. Represents the HTTP response. This message includes the status code, reason phrase, headers, and body." +} +}, +"type": "object" +}, "HeartBeat": { "description": "A single heart beat measurement.", "id": "HeartBeat", @@ -3584,6 +3617,10 @@ "description": "Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN).", "id": "HeartRateVariability", "properties": { +"metadata": { +"$ref": "HeartRateVariabilityMetadata", +"description": "Optional. Metadata used in 1P surfaces." +}, "rootMeanSquareOfSuccessiveDifferencesMilliseconds": { "description": "Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health.", "format": "double", @@ -3601,6 +3638,23 @@ }, "type": "object" }, +"HeartRateVariabilityMetadata": { +"description": "Metadata for HeartRateVariability.", +"id": "HeartRateVariabilityMetadata", +"properties": { +"highFrequencyPower": { +"description": "Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz).", +"format": "double", +"type": "number" +}, +"lowFrequencyPower": { +"description": "Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz).", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "HeartRateVariabilityPersonalRangeRollupValue": { "description": "Represents the result of the rollup of the user's daily heart rate variability personal range.", "id": "HeartRateVariabilityPersonalRangeRollupValue", @@ -4788,13 +4842,13 @@ "type": "integer" }, "autoRunningStrideLengthMm": { -"description": "Output only. The automatically calculated running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`", +"description": "Output only. The automatically calculated running stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`", "format": "int32", "readOnly": true, "type": "integer" }, "autoWalkingStrideLengthMm": { -"description": "Output only. The automatically calculated walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`", +"description": "Output only. The automatically calculated walking stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`", "format": "int32", "readOnly": true, "type": "integer" @@ -4809,12 +4863,12 @@ "type": "string" }, "userConfiguredRunningStrideLengthMm": { -"description": "Optional. The user's user configured running stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`", +"description": "Optional. The user's user configured running stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`", "format": "int32", "type": "integer" }, "userConfiguredWalkingStrideLengthMm": { -"description": "Optional. The user's user configured walking stride length, in millimeters. The user must consent to one of the following access scopes to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly` - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness`", +"description": "Optional. The user's user configured walking stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`", "format": "int32", "type": "integer" } diff --git a/googleapiclient/discovery_cache/documents/health.v4beta.json b/googleapiclient/discovery_cache/documents/health.v4beta.json new file mode 100644 index 0000000000..c1445a1b34 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/health.v4beta.json @@ -0,0 +1,6625 @@ +{ +"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." +}, +"https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly": { +"description": "See your Google Health activity and fitness data" +}, +"https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly": { +"description": "Add activity and fitness data to Google Health, and edit or delete the data it adds." +}, +"https://www.googleapis.com/auth/googlehealth.ecg.readonly": { +"description": "See your Google Health ECG data" +}, +"https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly": { +"description": "See your Google Health health metrics and measurement data" +}, +"https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly": { +"description": "Add health metric and measurements data to Google Health, and edit or delete the data it adds." +}, +"https://www.googleapis.com/auth/googlehealth.irn.readonly": { +"description": "See your Google Health Irregular Rhythm Notifications data" +}, +"https://www.googleapis.com/auth/googlehealth.location.readonly": { +"description": "See exercise GPS location data in Google Health" +}, +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly": { +"description": "See your Google Health logged symptoms data" +}, +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly": { +"description": "Add logged symptoms data to Google Health, and edit or delete the data it adds" +}, +"https://www.googleapis.com/auth/googlehealth.mindfulness.readonly": { +"description": "See your Google Health mindfulness data" +}, +"https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly": { +"description": "Add mindfulness data to Google Health, and edit or delete the data it adds" +}, +"https://www.googleapis.com/auth/googlehealth.nutrition.writeonly": { +"description": "Add nutrition data to Google Health, and edit or delete the data it adds." +}, +"https://www.googleapis.com/auth/googlehealth.profile.readonly": { +"description": "See your Google Health profile data" +}, +"https://www.googleapis.com/auth/googlehealth.profile.writeonly": { +"description": "Add profile data to Google Health, and edit or delete the data it adds." +}, +"https://www.googleapis.com/auth/googlehealth.reproductive_health.readonly": { +"description": "See your Google Health reproductive health data" +}, +"https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly": { +"description": "Add reproductive health data to Google Health, and edit or delete the data it adds" +}, +"https://www.googleapis.com/auth/googlehealth.settings.readonly": { +"description": "See your Google Health settings" +}, +"https://www.googleapis.com/auth/googlehealth.settings.writeonly": { +"description": "Add settings data to Google Health, and edit or delete the data it adds." +}, +"https://www.googleapis.com/auth/googlehealth.sleep.readonly": { +"description": "See your Google Health sleep data" +}, +"https://www.googleapis.com/auth/googlehealth.sleep.writeonly": { +"description": "Add sleep data to Google Health, and edit or delete the data it adds." +} +} +} +}, +"basePath": "", +"baseUrl": "https://health.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Google Health API", +"description": "The Google Health API lets you view and manage health and fitness metrics and measurement data.", +"discoveryVersion": "v1", +"documentationLink": "https://developers.google.com/health", +"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": "health:v4beta", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://health.mtls.googleapis.com/", +"name": "health", +"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": { +"subscribers": { +"methods": { +"create": { +"description": "Registers a new subscriber endpoint to receive notifications. A subscriber represents an application or service that wishes to receive data change notifications for users who have granted consent. **Endpoint Verification:** For a subscriber to be successfully created, the provided `endpoint_uri` must be a valid HTTPS endpoint and must pass an automated verification check. The backend will send two HTTP POST requests to the `endpoint_uri`: 1. **Verification with Authorization:** * **Headers:** Includes `Content-Type: application/json` and `Authorization` (with the exact value from `CreateSubscriberPayload.endpoint_authorization.secret`). * **Body:** `{\"type\": \"verification\"}` * **Expected Response:** HTTP `201 Created`. 2. **Verification without Authorization:** * **Headers:** Includes `Content-Type: application/json`. The `Authorization` header is OMITTED. * **Body:** `{\"type\": \"verification\"}` * **Expected Response:** HTTP `401 Unauthorized` or `403 Forbidden`. Both tests must pass for the subscriber creation to succeed. If verification fails, the operation will not be completed and an error will be returned. This process ensures the endpoint is reachable and correctly validates the `Authorization` header.", +"flatPath": "v4beta/projects/{projectsId}/subscribers", +"httpMethod": "POST", +"id": "health.projects.subscribers.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource where this subscriber will be created. Format: projects/{project_number} Example: projects/1234567890", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"subscriberId": { +"description": "Optional. The ID to use for the subscriber, which will become the final component of the subscriber's resource name. This value should be 4-36 characters, and valid characters are /[a-z]([a-z0-9-]{2,34}[a-z0-9])/.", +"location": "query", +"type": "string" +} +}, +"path": "v4beta/{+parent}/subscribers", +"request": { +"$ref": "CreateSubscriberPayload" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a subscriber registration. This will stop all notifications to the subscriber's endpoint.", +"flatPath": "v4beta/projects/{projectsId}/subscribers/{subscribersId}", +"httpMethod": "DELETE", +"id": "health.projects.subscribers.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "Optional. If set to true, any child resources (e.g., subscriptions) will also be deleted. If false (default) and child resources exist, the request will fail.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. The name of the subscriber to delete. Format: projects/{project}/subscribers/{subscriber} Example: projects/my-project/subscribers/my-subscriber-123 The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated if not provided during creation.", +"location": "path", +"pattern": "^projects/[^/]+/subscribers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all subscribers registered within the owned Google Cloud Project.", +"flatPath": "v4beta/projects/{projectsId}/subscribers", +"httpMethod": "GET", +"id": "health.projects.subscribers.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of subscribers to return. The service may return fewer than this value. If unspecified, at most 50 subscribers 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 `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent, which owns this collection of subscribers. Format: projects/{project}", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+parent}/subscribers", +"response": { +"$ref": "ListSubscribersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the configuration of an existing subscriber, such as the endpoint URI or the data types it's interested in. **Endpoint Verification:** If the `endpoint_uri` or `endpoint_authorization` field is included in the `update_mask`, the backend will re-verify the endpoint. The verification process is the same as described in `CreateSubscriber`: 1. **Verification with Authorization:** POST to the new or existing `endpoint_uri` with the new or existing `Authorization` secret. Expects HTTP `201 Created`. 2. **Verification without Authorization:** POST to the `endpoint_uri` without the `Authorization` header. Expects HTTP `401 Unauthorized` or `403 Forbidden`. Both tests must pass using the potentially updated values for the subscriber update to succeed. If verification fails, the update will not be applied, and an error will be returned.", +"flatPath": "v4beta/projects/{projectsId}/subscribers/{subscribersId}", +"httpMethod": "PATCH", +"id": "health.projects.subscribers.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the Subscriber. Format: projects/{project}/subscribers/{subscriber} The {project} ID is a Google Cloud Project ID or Project Number. The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise (e.g., a UUID). Example (User-settable subscriber ID): projects/my-project/subscribers/my-sub-123 Example (System-generated subscriber ID): projects/my-project/subscribers/a1b2c3d4-e5f6-7890-1234-567890abcdef", +"location": "path", +"pattern": "^projects/[^/]+/subscribers/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. A field mask that specifies which fields of the Subscriber message are to be updated. This allows for partial updates. Supported fields: - endpoint_uri - subscriber_configs - endpoint_authorization", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4beta/{+name}", +"request": { +"$ref": "Subscriber" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"subscriptions": { +"methods": { +"create": { +"description": "Creates a subscription for a specific user to a specific subscriber. This method requires the subscriber to have a `SubscriptionCreatePolicy` set to `MANUAL` for the given data types.", +"flatPath": "v4beta/projects/{projectsId}/subscribers/{subscribersId}/subscriptions", +"httpMethod": "POST", +"id": "health.projects.subscribers.subscriptions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise.", +"location": "path", +"pattern": "^projects/[^/]+/subscribers/[^/]+$", +"required": true, +"type": "string" +}, +"subscriptionId": { +"description": "Optional. The {subscription_id} is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise. If provided, the ID must be unique within the parent subscriber.", +"location": "query", +"type": "string" +} +}, +"path": "v4beta/{+parent}/subscriptions", +"request": { +"$ref": "CreateSubscriptionPayload" +}, +"response": { +"$ref": "Subscription" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a specific user subscription, stopping notifications for this user to this subscriber.", +"flatPath": "v4beta/projects/{projectsId}/subscribers/{subscribersId}/subscriptions/{subscriptionsId}", +"httpMethod": "DELETE", +"id": "health.projects.subscribers.subscriptions.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the subscription to delete. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated if not provided during creation.", +"location": "path", +"pattern": "^projects/[^/]+/subscribers/[^/]+/subscriptions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.", +"flatPath": "v4beta/projects/{projectsId}/subscribers/{subscribersId}/subscriptions", +"httpMethod": "GET", +"id": "health.projects.subscribers.subscriptions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter to apply to the list of subscriptions. The filter syntax is described in https://google.aip.dev/160. The filter can be applied to the following fields: - `user` - `data_type` The `user` identifier (e.g., `user1` in `users/user1`) refers to the public `health_user_id` Example: user = \"users/user1\" Example: user = \"users/user1\" OR user = \"users/user2\" Example: user = \"users/user1\" AND (data_type = \"sleep\" OR data_type = \"weight\")", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions 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 `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptions` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise.", +"location": "path", +"pattern": "^projects/[^/]+/subscribers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+parent}/subscriptions", +"response": { +"$ref": "ListSubscriptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the data types for an existing user subscription.", +"flatPath": "v4beta/projects/{projectsId}/subscribers/{subscribersId}/subscriptions/{subscriptionsId}", +"httpMethod": "PATCH", +"id": "health.projects.subscribers.subscriptions.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise.", +"location": "path", +"pattern": "^projects/[^/]+/subscribers/[^/]+/subscriptions/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4beta/{+name}", +"request": { +"$ref": "Subscription" +}, +"response": { +"$ref": "Subscription" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, +"shl": { +"resources": { +"m": { +"methods": { +"getShlManifest": { +"description": "Forward a manifest request for a given SHL", +"flatPath": "v4beta/shl/m/{externalShlId}", +"httpMethod": "POST", +"id": "health.shl.m.getShlManifest", +"parameterOrder": [ +"externalShlId" +], +"parameters": { +"externalShlId": { +"description": "Required. External ID mapping to a ShlSharedLinkCapabilityToken object See https://docs.google.com/document/d/1Pch20pxJHRbsaMxp0EYgs3ZU0Gu7QTUznk8LhvbQvfY/edit?tab=t.0#heading=h.17wg41voij6q", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v4beta/shl/m/{externalShlId}", +"request": { +"$ref": "ManifestParams" +}, +"response": { +"$ref": "HttpBody" +} +} +} +}, +"r": { +"methods": { +"get": { +"description": "Forward a resource request for a given SHL", +"flatPath": "v4beta/shl/r/{externalShlId}/{resourceToken}", +"httpMethod": "GET", +"id": "health.shl.r.get", +"parameterOrder": [ +"externalShlId", +"resourceToken" +], +"parameters": { +"externalShlId": { +"description": "Required. External ID mapping to a ShlSharedLinkCapabilityToken object See https://docs.google.com/document/d/1Pch20pxJHRbsaMxp0EYgs3ZU0Gu7QTUznk8LhvbQvfY/edit?tab=t.0#heading=h.17wg41voij6q", +"location": "path", +"required": true, +"type": "string" +}, +"resourceToken": { +"description": "Required. Encoded, encrypted message containing resource access details", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v4beta/shl/r/{externalShlId}/{resourceToken}", +"response": { +"$ref": "HttpBody" +} +} +} +} +} +}, +"users": { +"methods": { +"getIdentity": { +"description": "Gets the user's identity. It includes the legacy Fitbit user ID and the Google user ID and it can be used by migrating clients to map identifiers between the two systems.", +"flatPath": "v4beta/users/{usersId}/identity", +"httpMethod": "GET", +"id": "health.users.getIdentity", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Identity. Format: `users/me/identity`", +"location": "path", +"pattern": "^users/[^/]+/identity$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+name}", +"response": { +"$ref": "Identity" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", +"https://www.googleapis.com/auth/googlehealth.ecg.readonly", +"https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", +"https://www.googleapis.com/auth/googlehealth.irn.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.readonly", +"https://www.googleapis.com/auth/googlehealth.profile.readonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.readonly", +"https://www.googleapis.com/auth/googlehealth.settings.readonly", +"https://www.googleapis.com/auth/googlehealth.sleep.readonly" +] +}, +"getIrnProfile": { +"description": "Returns user's IRN Profile details.", +"flatPath": "v4beta/users/{usersId}/irnProfile", +"httpMethod": "GET", +"id": "health.users.getIrnProfile", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the IRN Profile. Format: `users/{user}/irnProfile` Example: `users/1234567890/irnProfile` or `users/me/irnProfile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.", +"location": "path", +"pattern": "^users/[^/]+/irnProfile$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+name}", +"response": { +"$ref": "IrnProfile" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.irn.readonly" +] +}, +"getProfile": { +"description": "Returns user Profile details.", +"flatPath": "v4beta/users/{usersId}/profile", +"httpMethod": "GET", +"id": "health.users.getProfile", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Profile. Format: `users/me/profile`.", +"location": "path", +"pattern": "^users/[^/]+/profile$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+name}", +"response": { +"$ref": "Profile" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.profile.readonly" +] +}, +"getSettings": { +"description": "Returns user settings details.", +"flatPath": "v4beta/users/{usersId}/settings", +"httpMethod": "GET", +"id": "health.users.getSettings", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Settings. Format: `users/me/settings`.", +"location": "path", +"pattern": "^users/[^/]+/settings$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+name}", +"response": { +"$ref": "Settings" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.settings.readonly" +] +}, +"updateProfile": { +"description": "Updates the user's profile details.", +"flatPath": "v4beta/users/{usersId}/profile", +"httpMethod": "PATCH", +"id": "health.users.updateProfile", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.", +"location": "path", +"pattern": "^users/[^/]+/profile$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4beta/{+name}", +"request": { +"$ref": "Profile" +}, +"response": { +"$ref": "Profile" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.profile.writeonly" +] +}, +"updateSettings": { +"description": "Updates the user's settings details.", +"flatPath": "v4beta/users/{usersId}/settings", +"httpMethod": "PATCH", +"id": "health.users.updateSettings", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of this Settings resource. Format: `users/{user}/settings` Example: `users/1234567890/settings` or `users/me/settings` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.", +"location": "path", +"pattern": "^users/[^/]+/settings$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4beta/{+name}", +"request": { +"$ref": "Settings" +}, +"response": { +"$ref": "Settings" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.settings.writeonly" +] +} +}, +"resources": { +"dataTypes": { +"resources": { +"dataPoints": { +"methods": { +"batchDelete": { +"description": "Delete a batch of identifyable data points.", +"flatPath": "v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:batchDelete", +"httpMethod": "POST", +"id": "health.users.dataTypes.dataPoints.batchDelete", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Optional. Parent (data type) for the Data Point collection Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/-` For a list of the supported data types see the DataPoint data union field. Deleting data points across multiple data type collections is supported following https://aip.dev/159. If this is set, the parent of all of the data points specified in `names` must match this field.", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+parent}/dataPoints:batchDelete", +"request": { +"$ref": "BatchDeleteDataPointsRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"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.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" +] +}, +"create": { +"description": "Creates a single identifiable data point.", +"flatPath": "v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints", +"httpMethod": "POST", +"id": "health.users.dataTypes.dataPoints.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name where the data point will be created. Format: `users/{user}/dataTypes/{data_type}`", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+parent}/dataPoints", +"request": { +"$ref": "DataPoint" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"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.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" +] +}, +"dailyRollUp": { +"description": "Roll up data points over civil time intervals for supported data types.", +"flatPath": "v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:dailyRollUp", +"httpMethod": "POST", +"id": "health.users.dataTypes.dataPoints.dailyRollUp", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Parent data type of the Data Point collection. Format: `users/{user}/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/distance` For a list of the supported data types see the DailyRollupDataPoint value union field.", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+parent}/dataPoints:dailyRollUp", +"request": { +"$ref": "DailyRollUpDataPointsRequest" +}, +"response": { +"$ref": "DailyRollUpDataPointsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", +"https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", +"https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", +"https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", +"https://www.googleapis.com/auth/googlehealth.location.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.readonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", +"https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.readonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly", +"https://www.googleapis.com/auth/googlehealth.sleep.readonly", +"https://www.googleapis.com/auth/googlehealth.sleep.writeonly" +] +}, +"exportExerciseTcx": { +"description": "Exports exercise data in TCX format. **IMPORTANT:** HTTP clients must append `?alt=media` to the request URL to download the raw TCX file. Example: `https://health.googleapis.com/v4/users/me/dataTypes/exercise/dataPoints/EXERCISE_ID:exportExerciseTcx?alt=media` Without `alt=media`, the server returns a JSON response (`ExportExerciseTcxResponse`) which is intended primarily for gRPC clients. **Note:** While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.", +"flatPath": "v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints/{dataPointsId}:exportExerciseTcx", +"httpMethod": "GET", +"id": "health.users.dataTypes.dataPoints.exportExerciseTcx", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the exercise data point to export. Format: `users/{user}/dataTypes/exercise/dataPoints/{data_point}` Example: `users/me/dataTypes/exercise/dataPoints/2026443605080188808` The `{user}` is the alias `\"me\"` currently. Future versions may support user IDs. The `{data_point}` ID maps to the exercise ID, which is a long integer.", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+/dataPoints/[^/]+$", +"required": true, +"type": "string" +}, +"partialData": { +"description": "Optional. Indicates whether to include the TCX data points when the GPS data is not available. If not specified, defaults to `false` and partial data will not be included.", +"location": "query", +"type": "boolean" +} +}, +"path": "v4beta/{+name}:exportExerciseTcx", +"response": { +"$ref": "ExportExerciseTcxResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", +"https://www.googleapis.com/auth/googlehealth.location.readonly" +], +"supportsMediaDownload": true, +"useMediaDownloadService": true +}, +"get": { +"description": "Get a single identifyable data point.", +"flatPath": "v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints/{dataPointsId}", +"httpMethod": "GET", +"id": "health.users.dataTypes.dataPoints.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the data point to retrieve. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` See DataPoint.name for examples and possible values.", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+/dataPoints/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+name}", +"response": { +"$ref": "DataPoint" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", +"https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", +"https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", +"https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", +"https://www.googleapis.com/auth/googlehealth.location.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.readonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", +"https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.readonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly", +"https://www.googleapis.com/auth/googlehealth.sleep.readonly", +"https://www.googleapis.com/auth/googlehealth.sleep.writeonly" +] +}, +"list": { +"description": "Query user health and fitness data points.", +"flatPath": "v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints", +"httpMethod": "GET", +"id": "health.users.dataTypes.dataPoints.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= \"2023-11-24T00:00:00Z\" AND steps.interval.start_time < \"2023-11-25T00:00:00Z\"` - `distance.interval.start_time >= \"2024-08-14T12:34:56Z\"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time >= \"2023-11-24\" AND steps.interval.civil_start_time < \"2023-11-25\"` - `distance.interval.civil_start_time >= \"2024-08-14T12:34:56\"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= \"2023-11-24T00:00:00Z\" AND weight.sample_time.physical_time < \"2023-11-25T00:00:00Z\"` - `weight.sample_time.physical_time >= \"2024-08-14T12:34:56Z\"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time >= \"2023-11-24\" AND weight.sample_time.civil_time < \"2023-11-25\"` - `weight.sample_time.civil_time >= \"2024-08-14T12:34:56\"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < \"2024-08-15\"` - Session civil start time (**Excluding Sleep and ECG**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time >= \"2023-11-24\" AND exercise.interval.civil_start_time < \"2023-11-25\"` - `exercise.interval.civil_start_time >= \"2024-08-14T12:34:56\"` - Session start time (**ECG specific**): - Pattern: `electrocardiogram.interval.start_time` - Supported comparison operators: `>=` - Timestamp literal expected in RFC-3339 format - Example: - `electrocardiogram.interval.start_time >= \"2024-08-14T12:34:56Z\"` - Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., `electrocardiogram.interval.end_time`) is not supported. - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= \"2023-11-24T00:00:00Z\" AND sleep.interval.end_time < \"2023-11-25T00:00:00Z\"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time >= \"2023-11-24\" AND sleep.interval.civil_end_time < \"2023-11-25\"` Data points in the response will be ordered by the interval start time in descending order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The `next_page_token` from a previous request, if any.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent data type of the Data Point collection. Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/weight` For a list of the supported data types see the DataPoint data union field.", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+parent}/dataPoints", +"response": { +"$ref": "ListDataPointsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", +"https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", +"https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", +"https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", +"https://www.googleapis.com/auth/googlehealth.location.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.readonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", +"https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.readonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly", +"https://www.googleapis.com/auth/googlehealth.sleep.readonly", +"https://www.googleapis.com/auth/googlehealth.sleep.writeonly" +] +}, +"patch": { +"description": "Updates a single identifiable data point. If a data point with the specified `name` is not found, the request will fail.", +"flatPath": "v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints/{dataPointsId}", +"httpMethod": "PATCH", +"id": "health.users.dataTypes.dataPoints.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"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.", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+/dataPoints/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+name}", +"request": { +"$ref": "DataPoint" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"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.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" +] +}, +"reconcile": { +"description": "Reconcile data points from multiple data sources into a single data stream.", +"flatPath": "v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:reconcile", +"httpMethod": "GET", +"id": "health.users.dataTypes.dataPoints.reconcile", +"parameterOrder": [ +"parent" +], +"parameters": { +"dataSourceFamily": { +"description": "Optional. The data source family name to reconcile. If empty, data points from all data sources will be reconciled. Format: `users/me/dataSourceFamilies/{data_source_family}` - `users/me/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/me/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/me/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect.", +"location": "query", +"type": "string" +}, +"filter": { +"description": "Optional. Filter expression based on https://aip.dev/160. A time range, either physical or civil, can be specified. See the ListDataPointsRequest.filter for the supported fields and syntax.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The `next_page_token` from a previous request, if any.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent data type of the Data Point collection. Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/heart-rate` For a list of the supported data types see the DataPoint data union field.", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+parent}/dataPoints:reconcile", +"response": { +"$ref": "ReconcileDataPointsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", +"https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", +"https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", +"https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", +"https://www.googleapis.com/auth/googlehealth.location.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.readonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", +"https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.readonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly", +"https://www.googleapis.com/auth/googlehealth.sleep.readonly", +"https://www.googleapis.com/auth/googlehealth.sleep.writeonly" +] +}, +"rollUp": { +"description": "Roll up data points over physical time intervals for supported data types.", +"flatPath": "v4beta/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:rollUp", +"httpMethod": "POST", +"id": "health.users.dataTypes.dataPoints.rollUp", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Parent data type of the Data Point collection. Format: `users/{user}/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/distance` For a list of the supported data types see the RollupDataPoint value union field.", +"location": "path", +"pattern": "^users/[^/]+/dataTypes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+parent}/dataPoints:rollUp", +"request": { +"$ref": "RollUpDataPointsRequest" +}, +"response": { +"$ref": "RollUpDataPointsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", +"https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", +"https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", +"https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", +"https://www.googleapis.com/auth/googlehealth.location.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.readonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", +"https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.readonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly", +"https://www.googleapis.com/auth/googlehealth.sleep.readonly", +"https://www.googleapis.com/auth/googlehealth.sleep.writeonly" +] +} +} +} +} +}, +"pairedDevices": { +"methods": { +"get": { +"description": "Returns user's Device.", +"flatPath": "v4beta/users/{usersId}/pairedDevices/{pairedDevicesId}", +"httpMethod": "GET", +"id": "health.users.pairedDevices.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the device to retrieve. Format: users/{user}/devices/{device}", +"location": "path", +"pattern": "^users/[^/]+/pairedDevices/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+name}", +"response": { +"$ref": "PairedDevice" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.settings.readonly" +] +}, +"list": { +"description": "Returns the user's list of paired 1P trackers and smartwatches.", +"flatPath": "v4beta/users/{usersId}/pairedDevices", +"httpMethod": "GET", +"id": "health.users.pairedDevices.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of devices to return. The service may return fewer than this value. If unspecified, at most 5 devices will be returned. The maximum value is 100. values above 100 will be coerced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListPairedDevices` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPairedDevices` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent, which owns this collection of devices. Format: users/{user}", +"location": "path", +"pattern": "^users/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4beta/{+parent}/pairedDevices", +"response": { +"$ref": "ListPairedDevicesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.settings.readonly" +] +} +} +} +} +} +}, +"revision": "20260908", +"rootUrl": "https://health.googleapis.com/", +"schemas": { +"ActiveEnergyBurned": { +"description": "Energy burned as part of an activity, excluding the basal energy burn.", +"id": "ActiveEnergyBurned", +"properties": { +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval" +}, +"kcal": { +"description": "Required. Energy burned during an activity, measured in kilocalories.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"ActiveEnergyBurnedRollupValue": { +"description": "Represents the result of the rollup of active energy burned.", +"id": "ActiveEnergyBurnedRollupValue", +"properties": { +"kcalSum": { +"description": "Output only. Sum of the active energy burned in kilocalories.", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, +"ActiveMinutes": { +"description": "Record of active minutes in a given time interval.", +"id": "ActiveMinutes", +"properties": { +"activeMinutesByActivityLevel": { +"description": "Required. Active minutes by activity level. At most one record per activity level is allowed.", +"items": { +"$ref": "ActiveMinutesByActivityLevel" +}, +"type": "array" +}, +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +} +}, +"type": "object" +}, +"ActiveMinutesByActivityLevel": { +"description": "Active minutes at a given activity level.", +"id": "ActiveMinutesByActivityLevel", +"properties": { +"activeMinutes": { +"description": "Required. Number of whole minutes spent in activity.", +"format": "int64", +"type": "string" +}, +"activityLevel": { +"description": "Required. The level of activity.", +"enum": [ +"ACTIVITY_LEVEL_UNSPECIFIED", +"LIGHT", +"MODERATE", +"VIGOROUS" +], +"enumDescriptions": [ +"Activity level is unspecified.", +"Light activity level.", +"Moderate activity level.", +"Vigorous activity level." +], +"type": "string" +} +}, +"type": "object" +}, +"ActiveMinutesRollupByActivityLevel": { +"description": "Active minutes by activity level.", +"id": "ActiveMinutesRollupByActivityLevel", +"properties": { +"activeMinutesSum": { +"description": "Number of whole minutes spent in activity.", +"format": "int64", +"type": "string" +}, +"activityLevel": { +"description": "The level of activity.", +"enum": [ +"ACTIVITY_LEVEL_UNSPECIFIED", +"LIGHT", +"MODERATE", +"VIGOROUS" +], +"enumDescriptions": [ +"Activity level is unspecified.", +"Light activity level.", +"Moderate activity level.", +"Vigorous activity level." +], +"type": "string" +} +}, +"type": "object" +}, +"ActiveMinutesRollupValue": { +"description": "Represents the result of the rollup of the active minutes data type.", +"id": "ActiveMinutesRollupValue", +"properties": { +"activeMinutesRollupByActivityLevel": { +"description": "Active minutes by activity level. At most one record per activity level is allowed.", +"items": { +"$ref": "ActiveMinutesRollupByActivityLevel" +}, +"type": "array" +} +}, +"type": "object" +}, +"ActiveZoneMinutes": { +"description": "Record of active zone minutes in a given time interval.", +"id": "ActiveZoneMinutes", +"properties": { +"activeZoneMinutes": { +"description": "Required. Number of Active Zone Minutes earned in the given time interval. Note: active_zone_minutes equals to 1 for low intensity (fat burn) zones or 2 for high intensity zones (cardio, peak).", +"format": "int64", +"type": "string" +}, +"heartRateZone": { +"description": "Required. Heart rate zone in which the active zone minutes have been earned, in the given time interval.", +"enum": [ +"HEART_RATE_ZONE_UNSPECIFIED", +"FAT_BURN", +"CARDIO", +"PEAK" +], +"enumDescriptions": [ +"Unspecified heart rate zone.", +"The fat burn heart rate zone.", +"The cardio heart rate zone.", +"The peak heart rate zone." +], +"type": "string" +}, +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +} +}, +"type": "object" +}, +"ActiveZoneMinutesRollupValue": { +"description": "Represents the result of the rollup of the active zone minutes data type.", +"id": "ActiveZoneMinutesRollupValue", +"properties": { +"sumInCardioHeartZone": { +"description": "Active zone minutes in `HeartRateZone.CARDIO`.", +"format": "int64", +"type": "string" +}, +"sumInFatBurnHeartZone": { +"description": "Active zone minutes in `HeartRateZone.FAT_BURN`.", +"format": "int64", +"type": "string" +}, +"sumInPeakHeartZone": { +"description": "Active zone minutes in `HeartRateZone.PEAK`.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"ActivityLevel": { +"description": "Internal type to capture activity level during a certain time interval.", +"id": "ActivityLevel", +"properties": { +"activityLevelType": { +"description": "Required. Activity level type in the given time interval.", +"enum": [ +"ACTIVITY_LEVEL_TYPE_UNSPECIFIED", +"SEDENTARY", +"LIGHTLY_ACTIVE", +"MODERATELY_ACTIVE", +"VERY_ACTIVE" +], +"enumDescriptions": [ +"Unspecified activity level type.", +"Sedentary activity level.", +"Lightly active activity level.", +"Moderately active activity level.", +"Very active activity level." +], +"type": "string" +}, +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +} +}, +"type": "object" +}, +"ActivityLevelRollupByActivityLevelType": { +"description": "Represents the total duration in a specific activity level type.", +"id": "ActivityLevelRollupByActivityLevelType", +"properties": { +"activityLevelType": { +"description": "Activity level type.", +"enum": [ +"ACTIVITY_LEVEL_TYPE_UNSPECIFIED", +"SEDENTARY", +"LIGHTLY_ACTIVE", +"MODERATELY_ACTIVE", +"VERY_ACTIVE" +], +"enumDescriptions": [ +"Unspecified activity level type.", +"Sedentary activity level.", +"Lightly active activity level.", +"Moderately active activity level.", +"Very active activity level." +], +"type": "string" +}, +"totalDuration": { +"description": "Total duration in the activity level type.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"ActivityLevelRollupValue": { +"description": "Represents the result of the rollup of the activity level data type.", +"id": "ActivityLevelRollupValue", +"properties": { +"activityLevelRollupsByActivityLevelType": { +"description": "List of total durations in each activity level type.", +"items": { +"$ref": "ActivityLevelRollupByActivityLevelType" +}, +"type": "array" +} +}, +"type": "object" +}, +"AlertWindow": { +"description": "An analysis window evaluated for AFib. Note: The current version of the algorithm will only produce alerts if all windows are positive. So anything returned from the API will always have the positive bit set to true. Internally, windows can be negative, however. We never save \"inconclusive\" windows (they aren't produced by the algorithm).", +"id": "AlertWindow", +"properties": { +"civilEndTime": { +"$ref": "CivilDateTime", +"description": "Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval", +"readOnly": true +}, +"civilStartTime": { +"$ref": "CivilDateTime", +"description": "Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval", +"readOnly": true +}, +"endTime": { +"description": "Required. The end time of the analysis window.", +"format": "google-datetime", +"type": "string" +}, +"endUtcOffset": { +"description": "Required. The UTC offset of the user's timezone when the analysis window ended.", +"format": "google-duration", +"type": "string" +}, +"heartBeats": { +"description": "Optional. All heart beats in the interval contained in this analysis window.", +"items": { +"$ref": "HeartBeat" +}, +"type": "array" +}, +"positive": { +"description": "Optional. Flag indicating whether the window was positive for AFib or not. A `true` value indicates that AFib was detected in this window. A `false` value means AFib was not detected, but does not guarantee the absence of AFib.", +"type": "boolean" +}, +"startTime": { +"description": "Required. Observed interval. The start time of the analysis window.", +"format": "google-datetime", +"type": "string" +}, +"startUtcOffset": { +"description": "Required. The UTC offset of the user's timezone when the analysis window started.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"Altitude": { +"description": "Captures the altitude gain (i.e. deltas), and not level above sea, for a user in millimeters.", +"id": "Altitude", +"properties": { +"gainMillimeters": { +"description": "Required. Altitude gain in millimeters over the observed interval.", +"format": "int64", +"type": "string" +}, +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +} +}, +"type": "object" +}, +"AltitudeRollupValue": { +"description": "Represents the result of the rollup of the user's altitude.", +"id": "AltitudeRollupValue", +"properties": { +"gainMillimetersSum": { +"description": "Sum of the altitude gain in millimeters.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"Application": { +"description": "Optional metadata for the application that provided this data.", +"id": "Application", +"properties": { +"googleWebClientId": { +"description": "Output only. The Google OAuth 2.0 client ID of the web application or service that recorded the data. This is the client ID used during the Google OAuth flow to obtain user credentials. This field is system-populated when the data is uploaded from Google Web API.", +"readOnly": true, +"type": "string" +}, +"packageName": { +"description": "Output only. A unique identifier for the mobile application that was the source of the data. This is typically the application's package name on Android (e.g., `com.google.fitbit`) or the bundle ID on iOS. This field is informational and helps trace data origin. This field is system-populated when the data is uploaded from the Fitbit mobile application, Health Connect or Health Kit.", +"readOnly": true, +"type": "string" +}, +"webClientId": { +"description": "Output only. The client ID of the application that recorded the data. This ID is a legacy Fitbit API client ID, which is different from a Google OAuth client ID. Example format: `ABC123`. This field is system-populated and used for tracing data from legacy Fitbit API integrations. This field is system-populated when the data is uploaded from a legacy Fitbit API integration.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BasalEnergyBurned": { +"description": "Number of calories burned due to basal metabolic rate (BMR) over a period of time.", +"id": "BasalEnergyBurned", +"properties": { +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +}, +"kcal": { +"description": "Required. Number of calories burned due to basal metabolic rate in kilocalories over the observed interval.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"BatchDeleteDataPointsRequest": { +"description": "Request to delete a batch of identifiable data points.", +"id": "BatchDeleteDataPointsRequest", +"properties": { +"names": { +"description": "Required. The names of the DataPoints to delete. A maximum of 10000 data points can be deleted in a single request.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"BloodGlucose": { +"description": "Represents a blood glucose level measurement. LINT: LEGACY_NAMES", +"id": "BloodGlucose", +"properties": { +"bloodGlucoseMilligramsPerDeciliter": { +"description": "Required. Blood glucose level concentration in mg/dL.", +"format": "double", +"type": "number" +}, +"mealType": { +"description": "Optional. Meal type of the measurement.", +"enum": [ +"MEAL_TYPE_UNSPECIFIED", +"BREAKFAST", +"LUNCH", +"DINNER", +"SNACK" +], +"enumDescriptions": [ +"Unspecified meal type.", +"Breakfast.", +"Lunch.", +"Dinner.", +"Snack." +], +"type": "string" +}, +"measurementSource": { +"description": "Optional. Source of the measurement.", +"enum": [ +"MEASUREMENT_SOURCE_UNSPECIFIED", +"SELF_MONITORING_BLOOD_GLUCOSE", +"CONTINUOUS_GLUCOSE_MONITORING", +"LAB_TEST" +], +"enumDescriptions": [ +"Unspecified measurement source.", +"Self-monitoring of blood glucose (Blood glucose meter)", +"Continuous glucose monitoring device", +"Laboratory test" +], +"type": "string" +}, +"measurementTiming": { +"description": "Optional. Timing of the measurement.", +"enum": [ +"MEASUREMENT_TIMING_UNSPECIFIED", +"AFTER_MEAL", +"BEFORE_MEAL", +"FASTING", +"GENERAL", +"BEFORE_BED", +"OVER_NIGHT" +], +"enumDescriptions": [ +"Unspecified measurement timing.", +"Measurement taken after meal.", +"Measurement taken before meal.", +"Measurement taken while fasting.", +"General measurement (not associated with a meal or time of day).", +"Measurement taken before bed.", +"Measurement taken over night." +], +"type": "string" +}, +"notes": { +"description": "Optional. Standard free-form notes captured at manual logging.", +"type": "string" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which blood glucose was measured." +}, +"specimen": { +"description": "Optional. Type of body fluid used to measure the blood glucose.", +"enum": [ +"SPECIMEN_UNSPECIFIED", +"CAPILLARY_BLOOD", +"INTERSTITIAL_FLUID", +"PLASMA", +"SERUM", +"TEARS", +"WHOLE_BLOOD" +], +"enumDescriptions": [ +"Unspecified specimen.", +"Capillary blood.", +"Interstitial fluid.", +"Plasma.", +"Serum.", +"Tears.", +"Whole blood." +], +"type": "string" +} +}, +"type": "object" +}, +"BloodGlucoseRollupValue": { +"description": "Represents the result of the rollup of the blood glucose data type. LINT: LEGACY_NAMES", +"id": "BloodGlucoseRollupValue", +"properties": { +"bloodGlucoseMilligramsPerDeciliterAvg": { +"description": "Average blood glucose level in mg/dL.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"BodyFat": { +"description": "Body fat measurement.", +"id": "BodyFat", +"properties": { +"percentage": { +"description": "Required. Body fat percentage, in range [0, 100].", +"format": "double", +"type": "number" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which body fat was measured." +} +}, +"type": "object" +}, +"BodyFatRollupValue": { +"description": "Represents the result of the rollup of the body fat data type.", +"id": "BodyFatRollupValue", +"properties": { +"bodyFatPercentageAvg": { +"description": "Average body fat percentage.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"CaloriesInHeartRateZoneRollupValue": { +"description": "Represents the result of the rollup of the calories in heart rate zone data type.", +"id": "CaloriesInHeartRateZoneRollupValue", +"properties": { +"caloriesInHeartRateZones": { +"description": "List of calories burned in each heart rate zone.", +"items": { +"$ref": "CaloriesInHeartRateZoneValue" +}, +"type": "array" +} +}, +"type": "object" +}, +"CaloriesInHeartRateZoneValue": { +"description": "Represents the amount of kilocalories burned in a specific heart rate zone.", +"id": "CaloriesInHeartRateZoneValue", +"properties": { +"heartRateZone": { +"description": "The heart rate zone.", +"enum": [ +"HEART_RATE_ZONE_TYPE_UNSPECIFIED", +"LIGHT", +"MODERATE", +"VIGOROUS", +"PEAK" +], +"enumDescriptions": [ +"Unspecified heart rate zone.", +"The light heart rate zone.", +"The moderate heart rate zone.", +"The vigorous heart rate zone.", +"The peak heart rate zone." +], +"type": "string" +}, +"kcal": { +"description": "The amount of kilocalories burned in the specified heart rate zone.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"CivilDateTime": { +"description": "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.", +"id": "CivilDateTime", +"properties": { +"date": { +"$ref": "Date", +"description": "Required. Calendar date." +}, +"time": { +"$ref": "TimeOfDay", +"description": "Optional. Time of day. Defaults to the start of the day, at midnight if omitted." +} +}, +"type": "object" +}, +"CivilTimeInterval": { +"description": "Counterpart of google.type.Interval, but using CivilDateTime.", +"id": "CivilTimeInterval", +"properties": { +"end": { +"$ref": "CivilDateTime", +"description": "Required. The exclusive end of the range." +}, +"start": { +"$ref": "CivilDateTime", +"description": "Required. The inclusive start of the range." +} +}, +"type": "object" +}, +"CoreBodyTemperature": { +"description": "Core body temperature measurement, distinct from peripheral body temperature, reflects the temperature of the body's internal organs.", +"id": "CoreBodyTemperature", +"properties": { +"id": { +"description": "Optional. The unique identifier of the core body temperature measurement.", +"type": "string" +}, +"measurementLocation": { +"description": "Optional. The location of the core body temperature measurement.", +"enum": [ +"MEASUREMENT_LOCATION_UNSPECIFIED", +"OTHER", +"ARMPIT", +"BODY", +"EAR", +"FINGER", +"GASTRO_INTESTINAL", +"MOUTH", +"RECTUM", +"TOE", +"EAR_DRUM", +"TEMPORAL_ARTERY", +"FOREHEAD", +"URINARY_BLADDER", +"NASAL", +"NASOPHARYNGEAL", +"WRIST", +"VAGINA" +], +"enumDescriptions": [ +"Measurement location is unspecified.", +"Other measurement location.", +"Armpit measurement location.", +"Body measurement location.", +"Ear measurement location.", +"Finger measurement location.", +"Gastro-intestinal measurement location.", +"Mouth measurement location.", +"Rectum measurement location.", +"Toe measurement location.", +"Ear drum measurement location.", +"Temporal artery measurement location.", +"Forehead measurement location.", +"Urinary bladder measurement location.", +"Nasal measurement location.", +"Nasopharyngeal measurement location.", +"Wrist measurement location.", +"Vagina measurement location." +], +"type": "string" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which core body temperature was measured." +}, +"temperatureCelsius": { +"description": "Required. The core body temperature in Celsius.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"CoreBodyTemperatureRollupValue": { +"description": "Represents the result of the rollup of the core body temperature data type.", +"id": "CoreBodyTemperatureRollupValue", +"properties": { +"temperatureCelsiusAvg": { +"description": "Average core body temperature in Celsius.", +"format": "double", +"type": "number" +}, +"temperatureCelsiusMax": { +"description": "Maximum core body temperature in Celsius.", +"format": "double", +"type": "number" +}, +"temperatureCelsiusMin": { +"description": "Minimum core body temperature in Celsius.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"CreateSubscriberPayload": { +"description": "Payload for creating a subscriber.", +"id": "CreateSubscriberPayload", +"properties": { +"endpointAuthorization": { +"$ref": "EndpointAuthorization", +"description": "Required. Authorization mechanism for the subscriber endpoint. The `secret` within this message is crucial for endpoint verification and for securing webhook notifications." +}, +"endpointUri": { +"description": "Required. The full HTTPS URI where update notifications will be sent. The URI must be a valid URL and use HTTPS as the scheme. This endpoint will be verified during the `CreateSubscriber` call. See CreateSubscriber RPC documentation for verification details.", +"type": "string" +}, +"subscriberConfigs": { +"description": "Optional. Configuration for the subscriber.", +"items": { +"$ref": "SubscriberConfig" +}, +"type": "array" +} +}, +"type": "object" +}, +"CreateSubscriptionPayload": { +"description": "Payload for creating a subscription.", +"id": "CreateSubscriptionPayload", +"properties": { +"dataTypes": { +"description": "Optional. Data types subscribed to.", +"items": { +"type": "string" +}, +"type": "array" +}, +"user": { +"description": "Required. Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).", +"type": "string" +} +}, +"type": "object" +}, +"DailyHeartRateVariability": { +"description": "Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds`", +"id": "DailyHeartRateVariability", +"properties": { +"averageHeartRateVariabilityMilliseconds": { +"description": "Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats.", +"format": "double", +"type": "number" +}, +"date": { +"$ref": "Date", +"description": "Required. Date (in the user's timezone) of heart rate variability measurement." +}, +"deepSleepRootMeanSquareOfSuccessiveDifferencesMilliseconds": { +"description": "Optional. The root mean square of successive differences (RMSSD) value during deep sleep.", +"format": "double", +"type": "number" +}, +"entropy": { +"description": "Optional. The Shanon entropy of heartbeat intervals. Entropy quantifies randomness or disorder in a system. High entropy indicates high HRV. Entropy is measured from the histogram of time interval between successive heart beats values measured during sleep.", +"format": "double", +"type": "number" +}, +"nonRemHeartRateBeatsPerMinute": { +"description": "Optional. Non-REM heart rate", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"DailyHeartRateZones": { +"description": "User's heart rate zone thresholds based on the Karvonen algorithm for a specific day.", +"id": "DailyHeartRateZones", +"properties": { +"date": { +"$ref": "Date", +"description": "Required. Date (in user's timezone) of the heart rate zones record." +}, +"heartRateZones": { +"description": "Required. The heart rate zones.", +"items": { +"$ref": "HeartRateZone" +}, +"type": "array" +} +}, +"type": "object" +}, +"DailyOxygenSaturation": { +"description": "A daily oxygen saturation (SpO2) record. Represents the user's daily oxygen saturation summary, typically calculated during sleep.", +"id": "DailyOxygenSaturation", +"properties": { +"averagePercentage": { +"description": "Required. The average value of the oxygen saturation samples during the sleep.", +"format": "double", +"type": "number" +}, +"date": { +"$ref": "Date", +"description": "Required. Date (in user's timezone) of the daily oxygen saturation record." +}, +"lowerBoundPercentage": { +"description": "Required. The lower bound of the confidence interval of oxygen saturation samples during sleep.", +"format": "double", +"type": "number" +}, +"standardDeviationPercentage": { +"description": "Optional. Standard deviation of the daily oxygen saturation averages from the past 7-30 days.", +"format": "double", +"type": "number" +}, +"upperBoundPercentage": { +"description": "Required. The upper bound of the confidence interval of oxygen saturation samples during sleep.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"DailyRespiratoryRate": { +"description": "A daily average respiratory rate (breaths per minute) for a day of the year. One data point per day calculated for the main sleep.", +"id": "DailyRespiratoryRate", +"properties": { +"breathsPerMinute": { +"description": "Required. The average number of breaths taken per minute.", +"format": "double", +"type": "number" +}, +"date": { +"$ref": "Date", +"description": "Required. The date on which the respiratory rate was measured." +} +}, +"type": "object" +}, +"DailyRestingHeartRate": { +"description": "Measures the daily resting heart rate for a user, calculated using the all day heart rate measurements.", +"id": "DailyRestingHeartRate", +"properties": { +"beatsPerMinute": { +"description": "Required. The resting heart rate value in beats per minute.", +"format": "int64", +"type": "string" +}, +"dailyRestingHeartRateMetadata": { +"$ref": "DailyRestingHeartRateMetadata", +"description": "Optional. Metadata for the daily resting heart rate." +}, +"date": { +"$ref": "Date", +"description": "Required. Date (in the user's timezone) of the resting heart rate measurement." +} +}, +"type": "object" +}, +"DailyRestingHeartRateMetadata": { +"description": "Metadata for the daily resting heart rate.", +"id": "DailyRestingHeartRateMetadata", +"properties": { +"calculationMethod": { +"description": "Required. The method used to calculate the resting heart rate.", +"enum": [ +"CALCULATION_METHOD_UNSPECIFIED", +"WITH_SLEEP", +"ONLY_WITH_AWAKE_DATA" +], +"enumDescriptions": [ +"The calculation method is unspecified.", +"The resting heart rate is calculated using the sleep data.", +"The resting heart rate is calculated using only awake data." +], +"type": "string" +} +}, +"type": "object" +}, +"DailyRollUpDataPointsRequest": { +"description": "Request to roll up data points by civil time intervals.", +"id": "DailyRollUpDataPointsRequest", +"properties": { +"dataSourceFamily": { +"description": "Optional. The data source family name to roll up. If empty, data points from all available data sources will be rolled up. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/me/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/me/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect.", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The `next_page_token` from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.", +"type": "string" +}, +"range": { +"$ref": "CivilTimeInterval", +"description": "Required. Closed-open range of data points that will be rolled up. The start time must be aligned with the aggregation window. The maximum range for `calories-in-heart-rate-zone`, `heart-rate`, `active-minutes` and `total-calories` is 14 days. The maximum range for all other data types is 90 days." +}, +"windowSizeDays": { +"description": "Optional. Aggregation window size, in number of days. Defaults to 1 if not specified. If the requested range is not an exact multiple of `window_size_days`, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than `window_size_days`.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"DailyRollUpDataPointsResponse": { +"description": "Response containing the list of rolled up data points.", +"id": "DailyRollUpDataPointsResponse", +"properties": { +"rollupDataPoints": { +"description": "Values for each aggregation time window.", +"items": { +"$ref": "DailyRollupDataPoint" +}, +"type": "array" +} +}, +"type": "object" +}, +"DailyRollupDataPoint": { +"description": "Value of a daily rollup for a single civil time interval (aggregation window) of reconciled data points from all data sources, excluding those data points that are identified as recorded by wearables in intervals when they were not actually worn.", +"id": "DailyRollupDataPoint", +"properties": { +"activeEnergyBurned": { +"$ref": "ActiveEnergyBurnedRollupValue", +"description": "Returned by default when rolling up data points from the `active-energy-burned` data type." +}, +"activeMinutes": { +"$ref": "ActiveMinutesRollupValue", +"description": "Returned by default when rolling up data points from the `active-minutes` data type, or when requested explicitly using the `active-minutes` rollup type identifier." +}, +"activeZoneMinutes": { +"$ref": "ActiveZoneMinutesRollupValue", +"description": "Returned by default when rolling up data points from the `active-zone-minutes` data type, or when requested explicitly using the `active-zone-minutes` rollup type identifier." +}, +"activityLevel": { +"$ref": "ActivityLevelRollupValue", +"description": "Returned by default when rolling up data points from the `activity-level` data type, or when requested explicitly using the `activity-level` rollup type identifier." +}, +"altitude": { +"$ref": "AltitudeRollupValue", +"description": "Returned by default when rolling up data points from the `altitude` data type, or when requested explicitly using the `altitude` rollup type identifier." +}, +"bloodGlucose": { +"$ref": "BloodGlucoseRollupValue", +"description": "Returned by default when rolling up data points from the `blood-glucose` data type." +}, +"bodyFat": { +"$ref": "BodyFatRollupValue", +"description": "Returned by default when rolling up data points from the `body-fat` data type, or when requested explicitly using the `body-fat` rollup type identifier." +}, +"caloriesInHeartRateZone": { +"$ref": "CaloriesInHeartRateZoneRollupValue", +"description": "Returned by default when rolling up data points from the `calories-in-heart-rate-zone` data type, or when requested explicitly using the `calories-in-heart-rate-zone` rollup type identifier." +}, +"civilEndTime": { +"$ref": "CivilDateTime", +"description": "End time of the window this value aggregates over" +}, +"civilStartTime": { +"$ref": "CivilDateTime", +"description": "Start time of the window this value aggregates over" +}, +"coreBodyTemperature": { +"$ref": "CoreBodyTemperatureRollupValue", +"description": "Returned by default when rolling up data points from the `core-body-temperature` data type, or when requested explicitly using the `core-body-temperature` rollup type identifier." +}, +"distance": { +"$ref": "DistanceRollupValue", +"description": "Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier." +}, +"floors": { +"$ref": "FloorsRollupValue", +"description": "Returned by default when rolling up data points from the `floors` data type, or when requested explicitly using the `floors` rollup type identifier." +}, +"heartRate": { +"$ref": "HeartRateRollupValue", +"description": "Returned by default when rolling up data points from the `heart-rate` data type, or when requested explicitly using the `heart-rate` rollup type identifier." +}, +"heartRateVariabilityPersonalRange": { +"$ref": "HeartRateVariabilityPersonalRangeRollupValue", +"description": "Returned by default when rolling up data points from the `daily-heart-rate-variability` data type, or when requested explicitly using the `heart-rate-variability-personal-range` rollup type identifier." +}, +"hydrationLog": { +"$ref": "HydrationLogRollupValue", +"description": "Returned by default when rolling up data points from the `hydration-log` data type, or when requested explicitly using the `hydration-log` rollup type identifier." +}, +"nutritionLog": { +"$ref": "NutritionLogRollupValue", +"description": "Returned by default when rolling up data points from the `nutrition-log` data type, or when requested explicitly using the `nutrition-log` rollup type identifier." +}, +"restingHeartRatePersonalRange": { +"$ref": "RestingHeartRatePersonalRangeRollupValue", +"description": "Returned by default when rolling up data points from the `daily-resting-heart-rate` data type, or when requested explicitly using the `resting-heart-rate-personal-range` rollup type identifier." +}, +"runVo2Max": { +"$ref": "RunVO2MaxRollupValue", +"description": "Returned by default when rolling up data points from the `run-vo2-max` data type, or when requested explicitly using the `run-vo2-max` rollup type identifier." +}, +"sedentaryPeriod": { +"$ref": "SedentaryPeriodRollupValue", +"description": "Returned by default when rolling up data points from the `sedentary-period` data type, or when requested explicitly using the `sedentary-period` rollup type identifier." +}, +"steps": { +"$ref": "StepsRollupValue", +"description": "Returned by default when rolling up data points from the `steps` data type, or when requested explicitly using the `steps` rollup type identifier." +}, +"swimLengthsData": { +"$ref": "SwimLengthsDataRollupValue", +"description": "Returned by default when rolling up data points from the `swim-lengths-data` data type, or when requested explicitly using the `swim-lengths-data` rollup type identifier." +}, +"timeInHeartRateZone": { +"$ref": "TimeInHeartRateZoneRollupValue", +"description": "Returned by default when rolling up data points from the `time-in-heart-rate-zone` data type, or when requested explicitly using the `time-in-heart-rate-zone` rollup type identifier." +}, +"totalCalories": { +"$ref": "TotalCaloriesRollupValue", +"description": "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." +}, +"weight": { +"$ref": "WeightRollupValue", +"description": "Returned by default when rolling up data points from the `weight` data type, or when requested explicitly using the `weight` rollup type identifier." +} +}, +"type": "object" +}, +"DailySleepTemperatureDerivations": { +"description": "Provides derived sleep temperature values, calculated from skin or internal device temperature readings during sleep.", +"id": "DailySleepTemperatureDerivations", +"properties": { +"baselineTemperatureCelsius": { +"description": "Optional. The user's baseline skin temperature. It is the median of the user's nightly skin temperature over the past 30 days.", +"format": "double", +"type": "number" +}, +"date": { +"$ref": "Date", +"description": "Required. Date for which the sleep temperature derivations are calculated." +}, +"nightlyTemperatureCelsius": { +"description": "Required. The user's nightly skin temperature. It is the mean of skin temperature samples taken from the user\u2019s sleep.", +"format": "double", +"type": "number" +}, +"relativeNightlyStddev30dCelsius": { +"description": "Optional. The standard deviation of the user\u2019s relative nightly skin temperature (temperature - baseline) over the past 30 days.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"DailyVO2Max": { +"description": "Contains a daily summary of the user's VO2 max (cardio fitness score), which is the maximum rate of oxygen the body can use during exercise.", +"id": "DailyVO2Max", +"properties": { +"cardioFitnessLevel": { +"description": "Optional. Represents the user's cardio fitness level based on their VO2 max.", +"enum": [ +"CARDIO_FITNESS_LEVEL_UNSPECIFIED", +"POOR", +"FAIR", +"AVERAGE", +"GOOD", +"VERY_GOOD", +"EXCELLENT" +], +"enumDescriptions": [ +"Unspecified cardio fitness level.", +"Poor cardio fitness level.", +"Fair cardio fitness level.", +"Average cardio fitness level.", +"Good cardio fitness level.", +"Very good cardio fitness level.", +"Excellent cardio fitness level." +], +"type": "string" +}, +"date": { +"$ref": "Date", +"description": "Required. The date for which the Daily VO2 max was measured." +}, +"estimated": { +"description": "Optional. An estimated field is added to indicate when the confidence has decreased sufficiently to consider the value an estimation.", +"type": "boolean" +}, +"vo2Max": { +"description": "Required. Daily VO2 max value measured as in ml consumed oxygen / kg of body weight / min.", +"format": "double", +"type": "number" +}, +"vo2MaxCovariance": { +"description": "Optional. The covariance of the VO2 max value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"DataPoint": { +"description": "A computed or recorded metric.", +"id": "DataPoint", +"properties": { +"activeEnergyBurned": { +"$ref": "ActiveEnergyBurned", +"description": "Optional. Data for points in the `active-energy-burned` interval data type collection." +}, +"activeMinutes": { +"$ref": "ActiveMinutes", +"description": "Optional. Data for points in the `active-minutes` interval data type collection." +}, +"activeZoneMinutes": { +"$ref": "ActiveZoneMinutes", +"description": "Optional. Data for points in the `active-zone-minutes` interval data type collection, measured in minutes." +}, +"activityLevel": { +"$ref": "ActivityLevel", +"description": "Optional. Data for points in the `activity-level` daily data type collection." +}, +"altitude": { +"$ref": "Altitude", +"description": "Optional. Data for points in the `altitude` interval data type collection." +}, +"basalEnergyBurned": { +"$ref": "BasalEnergyBurned", +"description": "Optional. Data for points in the `basal-energy-burned` interval data type collection." +}, +"bloodGlucose": { +"$ref": "BloodGlucose", +"description": "Optional. Data for points in the `blood-glucose` sample data type collection." +}, +"bodyFat": { +"$ref": "BodyFat", +"description": "Optional. Data for points in the `body-fat` sample data type collection." +}, +"coreBodyTemperature": { +"$ref": "CoreBodyTemperature", +"description": "Optional. Data for points in the `core-body-temperature` sample data type collection." +}, +"dailyHeartRateVariability": { +"$ref": "DailyHeartRateVariability", +"description": "Optional. Data for points in the `daily-heart-rate-variability` daily data type collection." +}, +"dailyHeartRateZones": { +"$ref": "DailyHeartRateZones", +"description": "Optional. Data for points in the `daily-heart-rate-zones` daily data type collection." +}, +"dailyOxygenSaturation": { +"$ref": "DailyOxygenSaturation", +"description": "Optional. Data for points in the `daily-oxygen-saturation` daily data type collection." +}, +"dailyRespiratoryRate": { +"$ref": "DailyRespiratoryRate", +"description": "Optional. Data for points in the `daily-respiratory-rate` daily data type collection." +}, +"dailyRestingHeartRate": { +"$ref": "DailyRestingHeartRate", +"description": "Optional. Data for points in the `daily-resting-heart-rate` daily data type collection." +}, +"dailySleepTemperatureDerivations": { +"$ref": "DailySleepTemperatureDerivations", +"description": "Optional. Data for points in the `daily-sleep-temperature-derivations` daily data type collection." +}, +"dailyVo2Max": { +"$ref": "DailyVO2Max", +"description": "Optional. Data for points in the `daily-vo2-max` daily data type collection." +}, +"dataSource": { +"$ref": "DataSource", +"description": "Optional. Data source information for the metric" +}, +"distance": { +"$ref": "Distance", +"description": "Optional. Data for points in the `distance` interval data type collection." +}, +"electrocardiogram": { +"$ref": "Electrocardiogram", +"description": "Optional. Data for points in the `electrocardiogram` session data type collection." +}, +"exercise": { +"$ref": "Exercise", +"description": "Optional. Data for points in the `exercise` session data type collection." +}, +"floors": { +"$ref": "Floors", +"description": "Optional. Data for points in the `floors` interval data type collection." +}, +"food": { +"$ref": "Food", +"description": "Optional. The food details." +}, +"foodMeasurementUnit": { +"$ref": "FoodMeasurementUnit", +"description": "Optional. The food measurement unit details." +}, +"heartRate": { +"$ref": "HeartRate", +"description": "Optional. Data for points in the `heart-rate` sample data type collection." +}, +"heartRateVariability": { +"$ref": "HeartRateVariability", +"description": "Optional. Data for points in the `heart-rate-variability` sample data type collection." +}, +"height": { +"$ref": "Height", +"description": "Optional. Data for points in the `height` sample data type collection." +}, +"hydrationLog": { +"$ref": "HydrationLog", +"description": "Optional. Data for points in the `hydration-log` session data type collection." +}, +"irregularRhythmNotification": { +"$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" +}, +"nutritionLog": { +"$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." +}, +"respiratoryRateSleepSummary": { +"$ref": "RespiratoryRateSleepSummary", +"description": "Optional. Data for points in the `respiratory-rate-sleep-summary` sample data type collection." +}, +"runVo2Max": { +"$ref": "RunVO2Max", +"description": "Optional. Data for points in the `run-vo2-max` sample data type collection." +}, +"sedentaryPeriod": { +"$ref": "SedentaryPeriod", +"description": "Optional. Data for points in the `sedentary-period` interval data type collection." +}, +"sleep": { +"$ref": "Sleep", +"description": "Optional. Data for points in the `sleep` session data type collection." +}, +"steps": { +"$ref": "Steps", +"description": "Optional. Data for points in the `steps` interval data type collection." +}, +"swimLengthsData": { +"$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." +}, +"vo2Max": { +"$ref": "VO2Max", +"description": "Optional. Data for points in the `vo2-max` sample data type collection." +}, +"weight": { +"$ref": "Weight", +"description": "Optional. Data for points in the `weight` sample data type collection." +} +}, +"type": "object" +}, +"DataSource": { +"description": "Data Source definition to track the origin of data. Each health data point, regardless of the complexity or data model (whether a simple step count or a detailed sleep session) must retain information about its source of origin (e.g. the device or app that collected it).", +"id": "DataSource", +"properties": { +"application": { +"$ref": "Application", +"description": "Output only. Captures metadata for the application that provided this data.", +"readOnly": true +}, +"device": { +"$ref": "Device", +"description": "Optional. Captures metadata for raw data points originating from devices. We expect this data source to be used for data points written on device sync." +}, +"platform": { +"description": "Output only. Captures the platform that uploaded the data.", +"enum": [ +"PLATFORM_UNSPECIFIED", +"FITBIT", +"HEALTH_CONNECT", +"HEALTH_KIT", +"FIT", +"FITBIT_WEB_API", +"NEST", +"GOOGLE_WEB_API", +"GOOGLE_PARTNER_INTEGRATION" +], +"enumDescriptions": [ +"The platform is unspecified.", +"The data was uploaded from Fitbit.", +"The data was uploaded from Health Connect.", +"The data was uploaded from Health Kit.", +"The data was uploaded from Google Fit.", +"The data was uploaded from Fitbit legacy Web API.", +"The data was uploaded from Nest devices.", +"The data was uploaded from Google Health API.", +"The data was uploaded from Google Partner Integrations." +], +"readOnly": true, +"type": "string" +}, +"recordingMethod": { +"description": "Optional. Captures how the data was recorded.", +"enum": [ +"RECORDING_METHOD_UNSPECIFIED", +"MANUAL", +"PASSIVELY_MEASURED", +"DERIVED", +"ACTIVELY_MEASURED", +"UNKNOWN" +], +"enumDescriptions": [ +"The recording method is unspecified.", +"The data was manually entered by the user.", +"The data was passively measured by a device.", +"The data was derived from other data, e.g., by an algorithm in the backend.", +"The data was actively measured by a device.", +"The recording method is unknown. This is set when the data is uploaded from a third party app that does not provide this information." +], +"type": "string" +} +}, +"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" +}, +"DateTime": { +"description": "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.", +"id": "DateTime", +"properties": { +"day": { +"description": "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.", +"format": "int32", +"type": "integer" +}, +"hours": { +"description": "Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", +"format": "int32", +"type": "integer" +}, +"minutes": { +"description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.", +"format": "int32", +"type": "integer" +}, +"month": { +"description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.", +"format": "int32", +"type": "integer" +}, +"nanos": { +"description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.", +"format": "int32", +"type": "integer" +}, +"seconds": { +"description": "Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.", +"format": "int32", +"type": "integer" +}, +"timeZone": { +"$ref": "TimeZone", +"description": "Time zone." +}, +"utcOffset": { +"description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.", +"format": "google-duration", +"type": "string" +}, +"year": { +"description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"Device": { +"description": "Captures metadata about the device that recorded the measurement.", +"id": "Device", +"properties": { +"displayName": { +"description": "Optional. An optional name for the device.", +"type": "string" +}, +"formFactor": { +"description": "Optional. Captures the form factor of the device.", +"enum": [ +"FORM_FACTOR_UNSPECIFIED", +"FITNESS_BAND", +"WATCH", +"PHONE", +"RING", +"CHEST_STRAP", +"SCALE", +"TABLET", +"HEAD_MOUNTED", +"SMART_DISPLAY" +], +"enumDescriptions": [ +"The form factor is unspecified.", +"The device is a fitness band.", +"The device is a watch.", +"The device is a phone.", +"The device is a ring.", +"The device is a chest strap.", +"The device is a scale.", +"The device is a tablet.", +"The device is a head mounted device.", +"The device is a smart display." +], +"type": "string" +}, +"manufacturer": { +"description": "Optional. An optional manufacturer of the device.", +"type": "string" +} +}, +"type": "object" +}, +"Distance": { +"description": "Distance traveled over an interval of time.", +"id": "Distance", +"properties": { +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +}, +"millimeters": { +"description": "Required. Distance in millimeters over the observed interval.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"DistanceRollupValue": { +"description": "Result of the rollup of the user's distance.", +"id": "DistanceRollupValue", +"properties": { +"millimetersSum": { +"description": "Sum of the distance in millimeters.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"Electrocardiogram": { +"description": "Represents an Electrocardiogram (ECG) measurement session. This data type is based on SaMD feature and any changes to it may require additional review.", +"id": "Electrocardiogram", +"properties": { +"beatsPerMinuteAvg": { +"description": "Optional. Average heart rate recorded during ECG reading in beats per minute.", +"format": "int64", +"type": "string" +}, +"interval": { +"$ref": "SessionTimeInterval", +"description": "Required. Observed interval. NOTE: Historical ECG data lacks timezone offsets, so `start_utc_offset` and `end_utc_offset` will be missing or default to zero. As a result, the civil time fields within this interval will default to UTC. It is recommended to use physical time fields instead for accurate time referencing. NOTE: The `start_time` and `end_time` of the interval are equal, representing the reading time." +}, +"leadNumber": { +"description": "Optional. The number of leads used for ECG reading.", +"format": "int32", +"type": "integer" +}, +"medicalDeviceInfo": { +"$ref": "MedicalDeviceInfo", +"description": "Output only. The meta information for the compatible device used to conduct the measurement. ECG measurements typically populate `firmware_version`, `feature_version`, and `device_model`.", +"readOnly": true +}, +"millivoltsScalingFactor": { +"description": "Optional. The factor by which to divide waveform samples to get voltage in millivolts: millivolts = waveform_sample / millivolts_scaling_factor.", +"format": "int32", +"type": "integer" +}, +"resultClassification": { +"description": "Optional. The result classification of the ECG reading.", +"enum": [ +"RESULT_CLASSIFICATION_UNSPECIFIED", +"NORMAL_SINUS_RHYTHM", +"ATRIAL_FIBRILLATION", +"INCONCLUSIVE", +"INCONCLUSIVE_HIGH_HEART_RATE", +"INCONCLUSIVE_LOW_HEART_RATE", +"UNREADABLE", +"NOT_ANALYZED" +], +"enumDescriptions": [ +"Unspecified result classification.", +"Heart rhythm appears normal. Corresponds to result \"Normal Sinus Rhythm\".", +"Signs of Atrial Fibrillation detected. Corresponds to result \"Atrial Fibrillation\".", +"The reading is inconclusive as it could not be classified. Corresponds to result \"Inconclusive\".", +"The reading is inconclusive as it could not be classified because heart rate is high (>120bpm). Corresponds to result \"Inconclusive: High heart rate\".", +"The reading is inconclusive as it could not be classified because heart rate is low (<50bpm). Corresponds to result \"Inconclusive: Low heart rate\".", +"The reading is unreadable.", +"The reading was not analyzed." +], +"type": "string" +}, +"samplingFrequencyHertz": { +"description": "Optional. The sampling frequency of waveform samples in hertz.", +"format": "int32", +"type": "integer" +}, +"waveformSamples": { +"description": "Optional. An array of voltage values representing lead I ECG values. Each sample represents voltage difference in ECG graph. The first value in array corresponds to the start of the reading.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +} +}, +"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" +}, +"EndpointAuthorization": { +"description": "Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `GOOGLE-HEALTH-API-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API.", +"id": "EndpointAuthorization", +"properties": { +"secret": { +"description": "Required. Input only. Provides a client-provided secret that will be sent with each notification to the subscriber endpoint using the \"Authorization\" header. The value must include the authorization scheme, e.g., \"Bearer \" or \"Basic \", as it will be used as the full Authorization header value. This secret is used by the API to test the endpoint during `CreateSubscriber` and `UpdateSubscriber` calls, and will be sent in the `Authorization` header for all subsequent webhook notifications to this endpoint.", +"type": "string" +}, +"secretSet": { +"description": "Output only. Whether the secret is set.", +"readOnly": true, +"type": "boolean" +} +}, +"type": "object" +}, +"EnergyQuantity": { +"description": "Represents the energy quantity.", +"id": "EnergyQuantity", +"properties": { +"kcal": { +"description": "Required. The energy value in kilocalories.", +"format": "double", +"type": "number" +}, +"userProvidedUnit": { +"description": "Optional. Value representing the user provided unit.", +"enum": [ +"ENERGY_UNIT_UNSPECIFIED", +"JOULE", +"KILOJOULE", +"KILOCALORIE", +"SMALL_CALORIE", +"CALORIE" +], +"enumDescriptions": [ +"Unspecified energy unit.", +"Value representing joule.", +"Value representing kilojoule.", +"Value representing kilocalorie.", +"Value representing small calorie.", +"Value representing calorie." +], +"type": "string" +} +}, +"type": "object" +}, +"EnergyQuantityRollup": { +"description": "Rollup for the energy quantity.", +"id": "EnergyQuantityRollup", +"properties": { +"kcalSum": { +"description": "Required. The sum of the energy in kilocalories.", +"format": "double", +"type": "number" +}, +"userProvidedUnitLast": { +"description": "Optional. The user provided unit on the last element.", +"enum": [ +"ENERGY_UNIT_UNSPECIFIED", +"JOULE", +"KILOJOULE", +"KILOCALORIE", +"SMALL_CALORIE", +"CALORIE" +], +"enumDescriptions": [ +"Unspecified energy unit.", +"Value representing joule.", +"Value representing kilojoule.", +"Value representing kilocalorie.", +"Value representing small calorie.", +"Value representing calorie." +], +"type": "string" +} +}, +"type": "object" +}, +"Exercise": { +"description": "An exercise that stores information about a physical activity.", +"id": "Exercise", +"properties": { +"activeDuration": { +"description": "Optional. Duration excluding pauses.", +"format": "google-duration", +"type": "string" +}, +"createTime": { +"description": "Output only. Represents the timestamp of the creation of the exercise.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"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": { +"description": "Optional. Exercise events that happen during an exercise, such as pause & restarts.", +"items": { +"$ref": "ExerciseEvent" +}, +"type": "array" +}, +"exerciseMetadata": { +"$ref": "ExerciseMetadata", +"description": "Optional. Additional exercise metadata." +}, +"exerciseType": { +"description": "Required. The type of activity performed during an exercise.", +"enum": [ +"EXERCISE_TYPE_UNSPECIFIED", +"AEROBIC_WORKOUT", +"ARCHERY", +"ASSAULT_BIKE", +"BACKPACKING", +"BADMINTON", +"BALLET", +"BALLROOM_DANCE", +"BARRE_CLASS", +"BASEBALL", +"BASKETBALL", +"BIKING", +"BILLIARDS", +"BODY_WEIGHT", +"BOOTCAMP", +"BOWLING", +"BOXING", +"BREAKDANCING", +"CALISTHENICS", +"CANOEING", +"CARDIO_SCULPT", +"CARDIO_WORKOUT", +"CARPENTRY", +"CHEERLEADING", +"CIRCUIT_TRAINING", +"CLEANING", +"CLIMBING", +"CORE_TRAINING", +"CRICKET", +"CROQUET", +"CROSS_COUNTRY_SKI", +"CROSS_TRAINING", +"CROSSFIT", +"CURLING", +"DANCING", +"DIVING", +"ELECTRIC_BIKE", +"ELECTRIC_SCOOTER", +"ELLIPTICAL", +"EQUESTRIAN_SPORTS", +"EXERCISE_CLASS", +"FENCING", +"FIELD_HOCKEY", +"FISHING", +"FITNESS_GAMING", +"FOILING", +"FOOTBALL_AMERICAN", +"FOOTBALL_AUSTRALIAN", +"FREE_WEIGHTS", +"FRISBEE_PLAYING_GENERAL", +"FUNCTIONAL_STRENGTH_TRAINING", +"GARDENING", +"GOLF", +"GYMNASTICS", +"HANDBALL", +"HAND_CYCLING", +"HIIT", +"HIKING", +"HIP_HOP", +"HOCKEY", +"HOEING", +"HOUSEHOLD_CHORES", +"HUNTING", +"ICE_SKATING", +"INCLINE_RUN", +"INCLINE_WALK", +"INDOOR_CLIMBING", +"INTERVAL_WORKOUT", +"JAZZ_DANCE", +"JIU_JITSU", +"JUMPING_ROPE", +"KARATE", +"KAYAKING", +"KICKBOXING", +"KITESURFING", +"LACROSSE", +"MARTIAL_ARTS", +"MEDITATE", +"MODERN_DANCE", +"MOTOCROSS", +"MOTORCYCLE", +"MOUNTAIN_BIKE", +"MOWING_LAWN", +"MUAY_THAI", +"MULTISPORT", +"MUSICAL_PERFORMANCE", +"NORDIC_WALKING", +"ORIENTEERING", +"OTHER", +"OUTDOOR_BIKE", +"OUTDOOR_WORKOUT", +"PADDLEBOARDING", +"PADEL", +"PAINTING", +"PARAGLIDING", +"PARKOUR", +"PICKELBALL", +"PILATES", +"POLO", +"POWERLIFTING", +"POWER_WALKING", +"RACKET_SPORTS", +"RACQUETBALL", +"RESISTANCE_BANDS", +"ROCK_CLIMBING", +"ROLLERBLADING", +"ROLLER_SKATING", +"ROWING", +"ROWING_MACHINE", +"RUCKING", +"RUGBY", +"RUNNING", +"SAILING", +"SCOOTERING", +"SCUBA_DIVING", +"SHOOTING", +"SHOVELING", +"SKATEBOARDING", +"SKATING", +"SKIING", +"SKYDIVING", +"SNORKELING", +"SNOWBOARDING", +"SNOWMOBILING", +"SNOWSHOEING", +"SNOW_SPORT", +"SOCCER", +"SOFTBALL", +"SPEED_SKATING", +"SPINNING", +"SPORT", +"SQUASH", +"STAIRCLIMBER", +"STATIONARY_BIKE", +"STEP_TRAINING", +"STRENGTH_TRAINING", +"STRETCHING", +"STROLLER_WALK", +"SURFING", +"SWIMMING", +"SWIMMING_OPEN_WATER", +"SWIMMING_POOL", +"SYNCHRONIZED_SWIMMING", +"TABATA_WORKOUT", +"TABLE_TENNIS", +"TAEKWONDO", +"TAI_CHI", +"TANGO", +"TENNIS", +"TRACK_AND_FIELD", +"TRAIL_RUN", +"TRAMPOLINE", +"TREADMILL", +"TREADMILL_WALK", +"TRX", +"ULTIMATE_FRISBEE", +"UNICYCLING", +"VOLLEYBALL", +"VOLLEYBALL_BEACH", +"WAKEBOARDING", +"WALKING", +"WALK_WITH_WEIGHTS", +"WATER_AEROBICS", +"WATER_JOGGING", +"WATER_POLO", +"WATER_SKIING", +"WATER_SPORT", +"WATER_VOLLEYBALL", +"WEEDING", +"WEIGHTLIFTING", +"WEIGHT_MACHINES", +"WEIGHTS", +"WHEELCHAIR", +"WINDSURFING", +"WORKOUT", +"WRESTLING", +"YOGA", +"YOGA_BIKRAM", +"YOGA_HATHA", +"YOGA_POWER", +"YOGA_VINYASA", +"ZUMBA" +], +"enumDescriptions": [ +"Exercise type is unspecified.", +"Aerobic workout type.", +"Archery type.", +"Assault bike type.", +"Backpacking type.", +"Badminton type.", +"Ballet type.", +"Ballroom dance type.", +"Barre class type.", +"Baseball type.", +"Basketball type.", +"Biking type.", +"Billiards type.", +"Body weight type.", +"Bootcamp type.", +"Bowling type.", +"Boxing type.", +"Breakdancing type.", +"Calisthenics type.", +"Canoeing type.", +"Cardio sculpt type.", +"Cardio workout type.", +"Carpentry type.", +"Cheerleading type.", +"Circuit training type.", +"Cleaning type.", +"Climbing type.", +"Core training type.", +"Cricket type.", +"Croquet type.", +"Cross country ski type.", +"Cross training type.", +"Crossfit type.", +"Curling type.", +"Dancing type.", +"Diving type.", +"Electric bike type.", +"Electric scooter type.", +"Elliptical type.", +"Equestrian sports type.", +"Exercise class type.", +"Fencing type.", +"Field hockey type.", +"Fishing type.", +"Fitness gaming type.", +"Foiling type.", +"Football american type.", +"Football australian type.", +"Free weights type.", +"Frisbee playing general type.", +"Functional strength training type.", +"Gardening type.", +"Golf type.", +"Gymnastics type.", +"Handball type.", +"Hand cycling type.", +"Hiit type.", +"Hiking type.", +"Hip hop type.", +"Hockey type.", +"Hoeing type.", +"Household chores type.", +"Hunting type.", +"Ice skating type.", +"Incline run type.", +"Incline walk type.", +"Indoor climbing type.", +"Interval workout type.", +"Jazz dance type.", +"Jiu jitsu type.", +"Jumping rope type.", +"Karate type.", +"Kayaking type.", +"Kickboxing type.", +"Kitesurfing type.", +"Lacrosse type.", +"Martial arts type.", +"Meditate type.", +"Modern dance type.", +"Motocross type.", +"Motorcycle type.", +"Mountain bike type.", +"Mowing lawn type.", +"Muay thai type.", +"Multisport type.", +"Musical performance type.", +"Nordic walking type.", +"Orienteering type.", +"Other type.", +"Outdoor bike type.", +"Outdoor workout type.", +"Paddleboarding type.", +"Padel type.", +"Painting type.", +"Paragliding type.", +"Parkour type.", +"Pickelball type.", +"Pilates type.", +"Polo type.", +"Powerlifting type.", +"Power walking type.", +"Racket sports type.", +"Racquetball type.", +"Resistance bands type.", +"Rock climbing type.", +"Rollerblading type.", +"Roller skating type.", +"Rowing type.", +"Rowing machine type.", +"Rucking type.", +"Rugby type.", +"Running type.", +"Sailing type.", +"Scootering type.", +"Scuba diving type.", +"Shooting type.", +"Shoveling type.", +"Skateboarding type.", +"Skating type.", +"Skiing type.", +"Skydiving type.", +"Snorkeling type.", +"Snowboarding type.", +"Snowmobiling type.", +"Snowshoeing type.", +"Snow sport type.", +"Soccer type.", +"Softball type.", +"Speed skating type.", +"Spinning type.", +"Sport type.", +"Squash type.", +"Stairclimber type.", +"Stationary bike type.", +"Step training type.", +"Strength training type.", +"Stretching type.", +"Stroller walk type.", +"Surfing type.", +"Swimming type.", +"Swimming open water type.", +"Swimming pool type.", +"Synchronized swimming type.", +"Tabata workout type.", +"Table tennis type.", +"Taekwondo type.", +"Tai chi type.", +"Tango type.", +"Tennis type.", +"Track and field type.", +"Trail run type.", +"Trampoline type.", +"Treadmill type.", +"Treadmill walk type.", +"Trx type.", +"Ultimate frisbee type.", +"Unicycling type.", +"Volleyball type.", +"Volleyball beach type.", +"Wakeboarding type.", +"Walking type.", +"Walk with weights type.", +"Water aerobics type.", +"Water jogging type.", +"Water polo type.", +"Water skiing type.", +"Water sport type.", +"Water volleyball type.", +"Weeding type.", +"Weightlifting type.", +"Weight machines type.", +"Weights type.", +"Wheelchair type.", +"Windsurfing type.", +"Workout type.", +"Wrestling type.", +"Yoga type.", +"Yoga bikram type.", +"Yoga hatha type.", +"Yoga power type.", +"Yoga vinyasa type.", +"Zumba type." +], +"type": "string" +}, +"interval": { +"$ref": "SessionTimeInterval", +"description": "Required. Observed exercise interval" +}, +"metricsSummary": { +"$ref": "MetricsSummary", +"description": "Required. Summary metrics for this exercise ( )" +}, +"notes": { +"description": "Optional. Standard free-form notes captured at manual logging.", +"type": "string" +}, +"splitSummaries": { +"description": "Optional. Laps or splits recorded within an exercise. Laps could be split based on distance or other criteria (duration, etc.) Laps should not be overlapping with each other.", +"items": { +"$ref": "SplitSummary" +}, +"type": "array" +}, +"splits": { +"description": "Optional. The default split is 1 km or 1 mile. - if the movement distance is less than the default, then there are no splits - if the movement distance is greater than or equal to the default, then we have splits", +"items": { +"$ref": "SplitSummary" +}, +"type": "array" +}, +"updateTime": { +"description": "Output only. This is the timestamp of the last update to the exercise.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ExerciseEvent": { +"description": "Represents instantaneous events that happen during an exercise, such as start, stop, pause, split.", +"id": "ExerciseEvent", +"properties": { +"eventTime": { +"description": "Required. Exercise event time", +"format": "google-datetime", +"type": "string" +}, +"eventUtcOffset": { +"description": "Required. Exercise event time offset from UTC", +"format": "google-duration", +"type": "string" +}, +"exerciseEventType": { +"description": "Required. The type of the event, such as start, stop, pause, resume.", +"enum": [ +"EXERCISE_EVENT_TYPE_UNSPECIFIED", +"START", +"STOP", +"PAUSE", +"RESUME", +"AUTO_PAUSE", +"AUTO_RESUME" +], +"enumDescriptions": [ +"Exercise event type is unspecified.", +"Exercise start event.", +"Exercise stop event.", +"Exercise pause event.", +"Exercise resume event.", +"Exercise auto-pause event.", +"Exercise auto-resume event." +], +"type": "string" +} +}, +"type": "object" +}, +"ExerciseMetadata": { +"description": "Additional exercise metadata.", +"id": "ExerciseMetadata", +"properties": { +"hasGps": { +"description": "Optional. Whether the exercise had GPS tracking.", +"type": "boolean" +}, +"poolLengthMillimeters": { +"description": "Optional. Pool length in millimeters. Only present in the swimming exercises.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"ExportExerciseTcxResponse": { +"description": "Represents a Response for exporting exercise data in TCX format.", +"id": "ExportExerciseTcxResponse", +"properties": { +"tcxData": { +"description": "Contains the exported TCX data. This field is intended for gRPC clients, as media download integration is not supported for gRPC. HTTP clients should instead use the `alt=media` query parameter to download the raw binary TCX file.", +"type": "string" +} +}, +"type": "object" +}, +"Floors": { +"description": "Gained elevation measured in floors over the time interval", +"id": "Floors", +"properties": { +"count": { +"description": "Required. Number of floors in the recorded interval", +"format": "int64", +"type": "string" +}, +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval" +} +}, +"type": "object" +}, +"FloorsRollupValue": { +"description": "Represents the result of the rollup of the user's floors.", +"id": "FloorsRollupValue", +"properties": { +"countSum": { +"description": "Sum of the floors count.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"Food": { +"description": "Represents a food item.", +"id": "Food", +"properties": { +"accessLevel": { +"description": "Required. The access level of the food.", +"enum": [ +"FOOD_ACCESS_LEVEL_UNSPECIFIED", +"FOOD_ACCESS_LEVEL_PUBLIC", +"FOOD_ACCESS_LEVEL_PRIVATE" +], +"enumDescriptions": [ +"Unspecified food access level.", +"Public food access level.", +"Private food access level." +], +"type": "string" +}, +"brand": { +"description": "Optional. The brand of the food.", +"type": "string" +}, +"defaultServing": { +"$ref": "FoodServing", +"description": "Required. Value representing the default serving of the food." +}, +"description": { +"description": "Optional. The description of the food.", +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the food.", +"type": "string" +}, +"energyAvg": { +"$ref": "EnergyQuantity", +"description": "Optional. Value representing the average energy of the food for the default serving." +}, +"energyFromFat": { +"$ref": "EnergyQuantity", +"description": "Optional. Value representing the energy from fat of the food for the default serving." +}, +"energyMax": { +"$ref": "EnergyQuantity", +"description": "Optional. Value representing the maximum energy of the food for the default serving." +}, +"energyMin": { +"$ref": "EnergyQuantity", +"description": "Optional. Value representing the minimum energy of the food for the default serving." +}, +"languageCode": { +"description": "Optional. The language code where the food is available in format xx-XX. Supported values are defined in Settings.food_language_code.", +"type": "string" +}, +"mealType": { +"description": "Optional. The meal type associated with this food.", +"enum": [ +"MEAL_TYPE_UNSPECIFIED", +"BEFORE_BREAKFAST", +"BREAKFAST", +"BEFORE_LUNCH", +"LUNCH", +"BEFORE_DINNER", +"DINNER", +"AFTER_DINNER", +"SNACK", +"ANYTIME" +], +"enumDescriptions": [ +"Unspecified meal type.", +"Value representing a meal before breakfast.", +"Value representing a breakfast.", +"Value representing a morning snack.", +"Value representing a lunch.", +"Value representing an afternoon snack.", +"Value representing dinner.", +"Value representing an evening snack.", +"Value representing any meal outside of the usual three meals per day.", +"Value representing any time (legacy NA)." +], +"type": "string" +}, +"nutrients": { +"description": "Optional. Value representing the nutrients of the food for the default serving.", +"items": { +"$ref": "NutrientQuantity" +}, +"type": "array" +}, +"servings": { +"description": "Optional. The serving of the food.", +"items": { +"$ref": "FoodServing" +}, +"type": "array" +}, +"totalCarbohydrate": { +"$ref": "WeightQuantity", +"description": "Optional. Value representing the total carbohydrate of the food for the default serving." +}, +"totalFat": { +"$ref": "WeightQuantity", +"description": "Optional. Value representing the total fat of the food for the default serving." +} +}, +"type": "object" +}, +"FoodMeasurementUnit": { +"description": "Represents a food measurement unit.", +"id": "FoodMeasurementUnit", +"properties": { +"displayName": { +"description": "Required. The display name of the food measurement unit (e.g., \"gram\", \"piece\").", +"type": "string" +}, +"pluralDisplayName": { +"description": "Optional. The plural display name of the food measurement unit (e.g., \"grams\", \"pieces\").", +"type": "string" +} +}, +"type": "object" +}, +"FoodServing": { +"description": "Represents different properties and information about the serving of a specific food.", +"id": "FoodServing", +"properties": { +"amount": { +"description": "Optional. Amount of food consumed, fractional values are supported.", +"format": "double", +"type": "number" +}, +"foodMeasurementUnit": { +"description": "Required. Food measurement unit", +"type": "string" +}, +"foodMeasurementUnitDisplayName": { +"description": "Output only. Legacy measurement unit for serving size in singular form (e.g. \"piece\", \"gram\").", +"readOnly": true, +"type": "string" +}, +"foodMeasurementUnitDisplayNamePlural": { +"description": "Output only. Legacy measurement unit for serving size in plural form (e.g. \"pieces\", \"grams\").", +"readOnly": true, +"type": "string" +}, +"multiplier": { +"description": "Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleDevicesandservicesHealthV4DataType": { +"description": "Represents a type of health data a user can have data points recorded for. It matches the parent resource of collection containing data points of the given type. Clients currently do not need to interact with this resource directly.", +"id": "GoogleDevicesandservicesHealthV4DataType", +"properties": { +"name": { +"description": "Identifier. The resource name of the data type. Format: `users/{user}/dataTypes/{data_type}` See DataPoint.name for examples and possible values.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleDevicesandservicesHealthV4User": { +"description": "Represents a user in the Google Health API. It matches the parent resource of collections owned by the user. Clients currently do not need to interact with this resource directly.", +"id": "GoogleDevicesandservicesHealthV4User", +"properties": { +"name": { +"description": "Identifier. The resource name of the user. The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. Format: `users/{user}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleDevicesandservicesHealthV4WebhookNotificationCloudLog": { +"description": "Log message for a webhook notification sent by the Google Health API to a subscriber's endpoint. Includes the HTTP response received from the endpoint.", +"id": "GoogleDevicesandservicesHealthV4WebhookNotificationCloudLog", +"properties": { +"httpResponse": { +"$ref": "HttpResponse", +"description": "Required. Represents the HTTP response. This message includes the status code, reason phrase, headers, and body." +} +}, +"type": "object" +}, +"GoogleDevicesandservicesHealthV4betaDataType": { +"description": "Represents a type of health data a user can have data points recorded for. It matches the parent resource of collection containing data points of the given type. Clients currently do not need to interact with this resource directly.", +"id": "GoogleDevicesandservicesHealthV4betaDataType", +"properties": { +"name": { +"description": "Identifier. The resource name of the data type. Format: `users/{user}/dataTypes/{data_type}` See DataPoint.name for examples and possible values.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleDevicesandservicesHealthV4betaUser": { +"description": "Represents a user in the Google Health API. It matches the parent resource of collections owned by the user. Clients currently do not need to interact with this resource directly.", +"id": "GoogleDevicesandservicesHealthV4betaUser", +"properties": { +"name": { +"description": "Identifier. The resource name of the user. The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. Format: `users/{user}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleDevicesandservicesHealthV4betaWebhookNotificationCloudLog": { +"description": "Log message for a webhook notification sent by the Google Health API to a subscriber's endpoint. Includes the HTTP response received from the endpoint.", +"id": "GoogleDevicesandservicesHealthV4betaWebhookNotificationCloudLog", +"properties": { +"httpResponse": { +"$ref": "HttpResponse", +"description": "Required. Represents the HTTP response. This message includes the status code, reason phrase, headers, and body." +} +}, +"type": "object" +}, +"HeartBeat": { +"description": "A single heart beat measurement.", +"id": "HeartBeat", +"properties": { +"beatsPerMinute": { +"description": "Required. The beats-per-minute value extrapolated from the time before the following heart beat. This is calculated as 60000 / rr, where rr is the gap between heart beats in milliseconds (IBI - Interbeat Interval).", +"format": "int32", +"type": "integer" +}, +"civilTime": { +"$ref": "CivilDateTime", +"description": "Output only. The civil time in the timezone the subject is in at the time of the observation.", +"readOnly": true +}, +"physicalTime": { +"description": "Required. The time of the heart beat measurement.", +"format": "google-datetime", +"type": "string" +}, +"utcOffset": { +"description": "Required. The UTC offset of the user's timezone when the heart beat measurement occurred.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"HeartRate": { +"description": "A heart rate measurement.", +"id": "HeartRate", +"properties": { +"beatsPerMinute": { +"description": "Required. The heart rate value in beats per minute.", +"format": "int64", +"type": "string" +}, +"metadata": { +"$ref": "HeartRateMetadata", +"description": "Optional. Metadata about the heart rate sample." +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. Observation time" +} +}, +"type": "object" +}, +"HeartRateMetadata": { +"description": "Heart rate metadata.", +"id": "HeartRateMetadata", +"properties": { +"motionContext": { +"description": "Optional. Indicates the user\u2019s level of activity when the heart rate sample was measured", +"enum": [ +"MOTION_CONTEXT_UNSPECIFIED", +"ACTIVE", +"SEDENTARY" +], +"enumDescriptions": [ +"The default value when no data is available.", +"The user is active.", +"The user is inactive." +], +"type": "string" +}, +"sensorLocation": { +"description": "Optional. Indicates the location of the sensor that measured the heart rate.", +"enum": [ +"SENSOR_LOCATION_UNSPECIFIED", +"CHEST", +"WRIST", +"FINGER", +"HAND", +"EAR_LOBE", +"FOOT" +], +"enumDescriptions": [ +"The default value when no data is available.", +"Chest sensor.", +"Wrist sensor.", +"Finger sensor.", +"Hand sensor.", +"Ear lobe sensor.", +"Foot sensor." +], +"type": "string" +} +}, +"type": "object" +}, +"HeartRateRollupValue": { +"description": "Represents the result of the rollup of the heart rate data type.", +"id": "HeartRateRollupValue", +"properties": { +"beatsPerMinuteAvg": { +"description": "The average heart rate value in the interval.", +"format": "double", +"type": "number" +}, +"beatsPerMinuteMax": { +"description": "The maximum heart rate value in the interval.", +"format": "double", +"type": "number" +}, +"beatsPerMinuteMin": { +"description": "The minimum heart rate value in the interval.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"HeartRateVariability": { +"description": "Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN).", +"id": "HeartRateVariability", +"properties": { +"metadata": { +"$ref": "HeartRateVariabilityMetadata", +"description": "Optional. Metadata used in 1P surfaces." +}, +"rootMeanSquareOfSuccessiveDifferencesMilliseconds": { +"description": "Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health.", +"format": "double", +"type": "number" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time of the heart rate variability measurement." +}, +"standardDeviationMilliseconds": { +"description": "Optional. The standard deviation of the heart rate variability measurement.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"HeartRateVariabilityMetadata": { +"description": "Metadata for HeartRateVariability.", +"id": "HeartRateVariabilityMetadata", +"properties": { +"highFrequencyPower": { +"description": "Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz).", +"format": "double", +"type": "number" +}, +"lowFrequencyPower": { +"description": "Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz).", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"HeartRateVariabilityPersonalRangeRollupValue": { +"description": "Represents the result of the rollup of the user's daily heart rate variability personal range.", +"id": "HeartRateVariabilityPersonalRangeRollupValue", +"properties": { +"averageHeartRateVariabilityMillisecondsMax": { +"description": "The upper bound of the user's average heart rate variability personal range.", +"format": "double", +"type": "number" +}, +"averageHeartRateVariabilityMillisecondsMin": { +"description": "The lower bound of the user's average heart rate variability personal range.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"HeartRateZone": { +"description": "The heart rate zone.", +"id": "HeartRateZone", +"properties": { +"heartRateZoneType": { +"description": "Required. The heart rate zone type.", +"enum": [ +"HEART_RATE_ZONE_TYPE_UNSPECIFIED", +"LIGHT", +"MODERATE", +"VIGOROUS", +"PEAK" +], +"enumDescriptions": [ +"Unspecified heart rate zone.", +"The light heart rate zone.", +"The moderate heart rate zone.", +"The vigorous heart rate zone.", +"The peak heart rate zone." +], +"type": "string" +}, +"maxBeatsPerMinute": { +"description": "Required. Maximum heart rate for this zone in beats per minute.", +"format": "int64", +"type": "string" +}, +"minBeatsPerMinute": { +"description": "Required. Minimum heart rate for this zone in beats per minute.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"Height": { +"description": "Body height measurement.", +"id": "Height", +"properties": { +"heightMillimeters": { +"description": "Required. Height of the user in millimeters.", +"format": "int64", +"type": "string" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which the height was recorded." +} +}, +"type": "object" +}, +"HttpBody": { +"description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", +"id": "HttpBody", +"properties": { +"contentType": { +"description": "The HTTP Content-Type header value specifying the content type of the body.", +"type": "string" +}, +"data": { +"description": "The HTTP request/response body as raw binary.", +"format": "byte", +"type": "string" +}, +"extensions": { +"description": "Application specific response metadata. Must be set in the first response for streaming APIs.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +} +}, +"type": "object" +}, +"HttpHeader": { +"description": "Represents an HTTP header.", +"id": "HttpHeader", +"properties": { +"key": { +"description": "The HTTP header key. It is case insensitive.", +"type": "string" +}, +"value": { +"description": "The HTTP header value.", +"type": "string" +} +}, +"type": "object" +}, +"HttpResponse": { +"description": "Represents an HTTP response.", +"id": "HttpResponse", +"properties": { +"body": { +"description": "The HTTP response body. If the body is not expected, it should be empty.", +"format": "byte", +"type": "string" +}, +"headers": { +"description": "The HTTP response headers. The ordering of the headers is significant. Multiple headers with the same key may present for the response.", +"items": { +"$ref": "HttpHeader" +}, +"type": "array" +}, +"reason": { +"description": "The HTTP reason phrase, such as \"OK\" or \"Not Found\".", +"type": "string" +}, +"status": { +"description": "The HTTP status code, such as 200 or 404.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"HydrationLog": { +"description": "Holds information about a user logged hydration.", +"id": "HydrationLog", +"properties": { +"amountConsumed": { +"$ref": "VolumeQuantity", +"description": "Required. Amount of liquid (ex. water) consumed." +}, +"interval": { +"$ref": "SessionTimeInterval", +"description": "Required. Observed interval." +} +}, +"type": "object" +}, +"HydrationLogRollupValue": { +"description": "Represents the result of the rollup of the hydration log data type.", +"id": "HydrationLogRollupValue", +"properties": { +"amountConsumed": { +"$ref": "VolumeQuantityRollup", +"description": "Rollup for amount consumed." +} +}, +"type": "object" +}, +"Identity": { +"description": "Represents details about the Google user's identity.", +"id": "Identity", +"properties": { +"healthUserId": { +"description": "Output only. The Google User Identifier in the Google Health APIs. It matches the `{user}` resource ID segment in the resource name paths, e.g. `users/{user}/dataTypes/steps`. Valid values are strings of 1-63 characters, and valid characters are lowercase and uppercase letters, numbers, and hyphens.", +"readOnly": true, +"type": "string" +}, +"legacyUserId": { +"description": "Output only. The legacy Fitbit User identifier. This is the Fitbit ID used in the legacy Fitbit APIs (v1-v3). It can be referenced by clients migrating from the legacy Fitbit APIs to map their existing identifiers to the new Google user ID. It **must not** be used for any other purpose. It is not of any use for new clients using only the Google Health APIs. Valid values are strings of 1-63 characters, and valid characters are lowercase and uppercase letters, numbers, and hyphens.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of this Identity resource. Format: `users/me/identity`", +"type": "string" +} +}, +"type": "object" +}, +"Interval": { +"description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", +"id": "Interval", +"properties": { +"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", +"type": "string" +}, +"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", +"type": "string" +} +}, +"type": "object" +}, +"IrnProfile": { +"description": "Irregular Rhythm Notifications (IRN) Profile details. The Irregular Rhythm Notifications (IRN) feature checks for signs of atrial fibrillation (AFib). The IrnProfile details include information about the user's onboarding status, enrollment status, and the last update time of analyzable data for this feature.", +"id": "IrnProfile", +"properties": { +"enrollmentStatus": { +"description": "Required. Whether or not the user is currently enrolled in having their data processed for IRN alerts.", +"type": "boolean" +}, +"name": { +"description": "Identifier. The resource name of this IrnProfile resource. Format: `users/{user}/irnProfile` Example: `users/1234567890/irnProfile` or `users/me/irnProfile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.", +"type": "string" +}, +"onboardingStatus": { +"description": "Required. Whether or not the user has onboarded onto the IRN feature.", +"type": "boolean" +}, +"updateTime": { +"description": "Output only. The timestamp of the last piece of analyzable data synced by the user.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"IrregularRhythmNotification": { +"description": "Represents an Irregular Rhythm Notification alert, indicating a potential sign of atrial fibrillation (AFib). This data type is based on SaMD feature and any changes to it may require additional review.", +"id": "IrregularRhythmNotification", +"properties": { +"alertWindows": { +"description": "Optional. The overlapping analysis windows that were used to evaluate rhythm for potential AFib, containing specific information about the user's heart rhythm.", +"items": { +"$ref": "AlertWindow" +}, +"type": "array" +}, +"interval": { +"$ref": "SessionTimeInterval", +"description": "Required. Observed interval." +}, +"medicalDeviceInfo": { +"$ref": "MedicalDeviceInfo", +"description": "Output only. The meta information for the compatible device used to conduct the measurement. Irregular Rhythm Notification measurements typically populate `algorithm_version`, `service_version`, and `device_model`.", +"readOnly": true +} +}, +"type": "object" +}, +"ListDataPointsResponse": { +"description": "Response containing raw data points matching the query", +"id": "ListDataPointsResponse", +"properties": { +"dataPoints": { +"description": "Data points matching the query", +"items": { +"$ref": "DataPoint" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Next page token, empty if the response is complete", +"type": "string" +} +}, +"type": "object" +}, +"ListPairedDevicesResponse": { +"description": "Response message for ListPairedDevices.", +"id": "ListPairedDevicesResponse", +"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" +}, +"pairedDevices": { +"description": "The paired devices of the user.", +"items": { +"$ref": "PairedDevice" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListSubscribersResponse": { +"description": "Response message for ListSubscribers.", +"id": "ListSubscribersResponse", +"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" +}, +"subscribers": { +"description": "Subscribers from the specified project.", +"items": { +"$ref": "Subscriber" +}, +"type": "array" +}, +"totalSize": { +"description": "The total number of subscribers matching the request.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"ListSubscriptionsResponse": { +"description": "Response message for ListSubscriptions.", +"id": "ListSubscriptionsResponse", +"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" +}, +"subscriptions": { +"description": "The subscriptions from the specified subscriber.", +"items": { +"$ref": "Subscription" +}, +"type": "array" +} +}, +"type": "object" +}, +"ManifestParams": { +"description": "Represents the POST body contained in a GetShlManifestRequest This message is nested to represent that See https://build.fhir.org/ig/HL7/smart-health-cards-and-links/links-specification.html#smart-health-link-manifest-request", +"id": "ManifestParams", +"properties": { +"embeddedLengthMax": { +"description": "Optional. Integer upper bound on the length of embedded payloads", +"format": "int32", +"type": "integer" +}, +"passcode": { +"description": "Optional. ", +"type": "string" +}, +"recipient": { +"description": "Required. A string describing the recipient (e.g.,the name of an organization or person) suitable for display to the Receiving User", +"type": "string" +} +}, +"type": "object" +}, +"MedicalDeviceInfo": { +"description": "Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI).", +"id": "MedicalDeviceInfo", +"properties": { +"algorithmVersion": { +"description": "Output only. The algorithm version used by the feature.", +"readOnly": true, +"type": "string" +}, +"deviceModel": { +"description": "Output only. The model name or device type of the compatible device used to collect the data.", +"readOnly": true, +"type": "string" +}, +"featureVersion": { +"description": "Output only. The version of the feature/app running on the device.", +"readOnly": true, +"type": "string" +}, +"firmwareVersion": { +"description": "Output only. The firmware version running on the compatible device used to collect the data.", +"readOnly": true, +"type": "string" +}, +"serviceVersion": { +"description": "Output only. The service version used by the feature.", +"readOnly": true, +"type": "string" +} +}, +"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", +"properties": { +"activeZoneMinutes": { +"description": "Optional. Total active zone minutes for the exercise.", +"format": "int64", +"type": "string" +}, +"averageHeartRateBeatsPerMinute": { +"description": "Optional. Average heart rate during the exercise.", +"format": "int64", +"type": "string" +}, +"averagePaceSecondsPerMeter": { +"description": "Optional. Average pace in seconds per meter.", +"format": "double", +"type": "number" +}, +"averageSpeedMillimetersPerSecond": { +"description": "Optional. Average speed in millimeters per second.", +"format": "double", +"type": "number" +}, +"caloriesKcal": { +"description": "Optional. Total calories burned by the user during the exercise.", +"format": "double", +"type": "number" +}, +"distanceMillimeters": { +"description": "Optional. Total distance covered by the user during the exercise.", +"format": "double", +"type": "number" +}, +"elevationGainMillimeters": { +"description": "Optional. Total elevation gain during the exercise.", +"format": "double", +"type": "number" +}, +"heartRateZoneDurations": { +"$ref": "TimeInHeartRateZones", +"description": "Optional. Time spent in each heart rate zone." +}, +"mobilityMetrics": { +"$ref": "MobilityMetrics", +"description": "Optional. Mobility workouts specific metrics. Only present in the advanced running exercises." +}, +"runVo2Max": { +"description": "Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.", +"format": "double", +"type": "number" +}, +"steps": { +"description": "Optional. Total steps taken during the exercise.", +"format": "int64", +"type": "string" +}, +"totalSwimLengths": { +"description": "Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"MobilityMetrics": { +"description": "Mobility workouts specific metrics", +"id": "MobilityMetrics", +"properties": { +"avgCadenceStepsPerMinute": { +"description": "Optional. Cadence is a measure of the frequency of your foot strikes. Steps / min in real time during workout.", +"format": "double", +"type": "number" +}, +"avgGroundContactTimeDuration": { +"description": "Optional. The ground contact time for a particular stride is the amount of time for which the foot was in contact with the ground on that stride", +"format": "google-duration", +"type": "string" +}, +"avgStrideLengthMillimeters": { +"description": "Optional. Stride length is a measure of the distance covered by a single stride", +"format": "int64", +"type": "string" +}, +"avgVerticalOscillationMillimeters": { +"description": "Optional. Distance off the ground your center of mass moves with each stride while running", +"format": "int64", +"type": "string" +}, +"avgVerticalRatio": { +"description": "Optional. Vertical oscillation/stride length between [5.0, 11.0].", +"format": "double", +"type": "number" +} +}, +"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", +"properties": { +"nutrient": { +"description": "Required. The nutrient type.", +"enum": [ +"NUTRIENT_UNSPECIFIED", +"BIOTIN", +"CAFFEINE", +"CALCIUM", +"CHLORIDE", +"CARBOHYDRATES", +"CHOLESTEROL", +"CHROMIUM", +"COPPER", +"DIETARY_FIBER", +"FOLIC_ACID", +"IODINE", +"IRON", +"MAGNESIUM", +"MANGANESE", +"MOLYBDENUM", +"MONOUNSATURATED_FAT", +"NIACIN", +"PANTOTHENIC_ACID", +"PHOSPHORUS", +"POLYUNSATURATED_FAT", +"POTASSIUM", +"PROTEIN", +"RIBOFLAVIN", +"SATURATED_FAT", +"SELENIUM", +"SODIUM", +"SUGAR", +"THIAMIN", +"TRANS_FAT", +"UNSATURATED_FAT", +"VITAMIN_A", +"VITAMIN_B12", +"VITAMIN_B6", +"VITAMIN_C", +"VITAMIN_D", +"VITAMIN_E", +"VITAMIN_K", +"ZINC", +"FOLATE" +], +"enumDescriptions": [ +"Unspecified nutrient.", +"Value representing biotin nutrient.", +"Value representing caffeine nutrient.", +"Value representing calcium nutrient.", +"Value representing chloride nutrient.", +"Value representing carbohydrates nutrient.", +"Value representing cholesterol nutrient.", +"Value representing chromium nutrient.", +"Value representing copper nutrient.", +"Value representing dietary fiber nutrient.", +"Value representing folic acid nutrient.", +"Value representing iodine nutrient.", +"Value representing iron nutrient.", +"Value representing magnesium nutrient.", +"Value representing manganese nutrient.", +"Value representing molybdenum nutrient.", +"Value representing monounsaturated fat nutrient.", +"Value representing niacin nutrient.", +"Value representing pantothenic acid nutrient.", +"Value representing phosphorus nutrient.", +"Value representing polyunsaturated fat nutrient.", +"Value representing potassium nutrient.", +"Value representing protein nutrient.", +"Value representing riboflavin nutrient.", +"Value representing saturated fat nutrient.", +"Value representing selenium nutrient.", +"Value representing sodium nutrient.", +"Value representing sugar nutrient.", +"Value representing thiamin nutrient.", +"Value representing trans fat nutrient.", +"Value representing unsaturated fat nutrient.", +"Value representing vitamin A nutrient.", +"Value representing vitamin B12 nutrient.", +"Value representing vitamin B6 nutrient.", +"Value representing vitamin C nutrient.", +"Value representing vitamin D nutrient.", +"Value representing vitamin E nutrient.", +"Value representing vitamin K nutrient.", +"Value representing zinc nutrient.", +"Value representing folate nutrient." +], +"type": "string" +}, +"quantity": { +"$ref": "WeightQuantity", +"description": "Required. The quantity of the nutrient, measured in grams." +} +}, +"type": "object" +}, +"NutrientQuantityRollup": { +"description": "Nutrient quantity rollup.", +"id": "NutrientQuantityRollup", +"properties": { +"nutrient": { +"description": "Required. Aggregated nutrient.", +"enum": [ +"NUTRIENT_UNSPECIFIED", +"BIOTIN", +"CAFFEINE", +"CALCIUM", +"CHLORIDE", +"CARBOHYDRATES", +"CHOLESTEROL", +"CHROMIUM", +"COPPER", +"DIETARY_FIBER", +"FOLIC_ACID", +"IODINE", +"IRON", +"MAGNESIUM", +"MANGANESE", +"MOLYBDENUM", +"MONOUNSATURATED_FAT", +"NIACIN", +"PANTOTHENIC_ACID", +"PHOSPHORUS", +"POLYUNSATURATED_FAT", +"POTASSIUM", +"PROTEIN", +"RIBOFLAVIN", +"SATURATED_FAT", +"SELENIUM", +"SODIUM", +"SUGAR", +"THIAMIN", +"TRANS_FAT", +"UNSATURATED_FAT", +"VITAMIN_A", +"VITAMIN_B12", +"VITAMIN_B6", +"VITAMIN_C", +"VITAMIN_D", +"VITAMIN_E", +"VITAMIN_K", +"ZINC", +"FOLATE" +], +"enumDescriptions": [ +"Unspecified nutrient.", +"Value representing biotin nutrient.", +"Value representing caffeine nutrient.", +"Value representing calcium nutrient.", +"Value representing chloride nutrient.", +"Value representing carbohydrates nutrient.", +"Value representing cholesterol nutrient.", +"Value representing chromium nutrient.", +"Value representing copper nutrient.", +"Value representing dietary fiber nutrient.", +"Value representing folic acid nutrient.", +"Value representing iodine nutrient.", +"Value representing iron nutrient.", +"Value representing magnesium nutrient.", +"Value representing manganese nutrient.", +"Value representing molybdenum nutrient.", +"Value representing monounsaturated fat nutrient.", +"Value representing niacin nutrient.", +"Value representing pantothenic acid nutrient.", +"Value representing phosphorus nutrient.", +"Value representing polyunsaturated fat nutrient.", +"Value representing potassium nutrient.", +"Value representing protein nutrient.", +"Value representing riboflavin nutrient.", +"Value representing saturated fat nutrient.", +"Value representing selenium nutrient.", +"Value representing sodium nutrient.", +"Value representing sugar nutrient.", +"Value representing thiamin nutrient.", +"Value representing trans fat nutrient.", +"Value representing unsaturated fat nutrient.", +"Value representing vitamin A nutrient.", +"Value representing vitamin B12 nutrient.", +"Value representing vitamin B6 nutrient.", +"Value representing vitamin C nutrient.", +"Value representing vitamin D nutrient.", +"Value representing vitamin E nutrient.", +"Value representing vitamin K nutrient.", +"Value representing zinc nutrient.", +"Value representing folate nutrient." +], +"type": "string" +}, +"quantity": { +"$ref": "WeightQuantityRollup", +"description": "Required. Aggregated nutrient weight." +} +}, +"type": "object" +}, +"NutritionLog": { +"description": "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.", +"id": "NutritionLog", +"properties": { +"energy": { +"$ref": "EnergyQuantity", +"description": "Optional. The total energy of the food, measured in kilocalories (`kcal`)." +}, +"energyFromFat": { +"$ref": "EnergyQuantity", +"description": "Optional. The energy from fat, measured in kilocalories (`kcal`)." +}, +"food": { +"description": "Optional. The resource name of the Food item. Required when creating a nutrition log from an identified food. For anonymous food logs, use the `food_display_name` field instead.", +"type": "string" +}, +"foodDisplayName": { +"description": "The display name of the food. For identified food logs, this is populated automatically from the referenced food.", +"type": "string" +}, +"interval": { +"$ref": "SessionTimeInterval", +"description": "Required. The time window when the food was logged." +}, +"mealType": { +"description": "Optional. The meal category. One of `BREAKFAST`, `LUNCH`, `DINNER`, or `SNACK`.", +"enum": [ +"MEAL_TYPE_UNSPECIFIED", +"BEFORE_BREAKFAST", +"BREAKFAST", +"BEFORE_LUNCH", +"LUNCH", +"BEFORE_DINNER", +"DINNER", +"AFTER_DINNER", +"SNACK", +"ANYTIME" +], +"enumDescriptions": [ +"Unspecified meal type.", +"Value representing a meal before breakfast.", +"Value representing a breakfast.", +"Value representing a morning snack.", +"Value representing a lunch.", +"Value representing an afternoon snack.", +"Value representing dinner.", +"Value representing an evening snack.", +"Value representing any meal outside of the usual three meals per day.", +"Value representing any time (legacy NA)." +], +"type": "string" +}, +"nutrients": { +"description": "Optional. An array of individual nutrient values for the nutrition log.", +"items": { +"$ref": "NutrientQuantity" +}, +"type": "array" +}, +"serving": { +"$ref": "Serving", +"description": "Optional. The serving information for the logged food." +}, +"totalCarbohydrate": { +"$ref": "WeightQuantity", +"description": "Optional. The total carbohydrate content, measured in grams." +}, +"totalFat": { +"$ref": "WeightQuantity", +"description": "Optional. The total fat content, measured in grams." +} +}, +"type": "object" +}, +"NutritionLogRollupValue": { +"description": "Represents the result of the rollup of the nutrition log data type.", +"id": "NutritionLogRollupValue", +"properties": { +"energy": { +"$ref": "EnergyQuantityRollup", +"description": "Energy rollup." +}, +"energyFromFat": { +"$ref": "EnergyQuantityRollup", +"description": "Value Energy from fat rollup." +}, +"nutrients": { +"description": "List of the nutrient roll-ups by the nutrient type.", +"items": { +"$ref": "NutrientQuantityRollup" +}, +"type": "array" +}, +"totalCarbohydrate": { +"$ref": "WeightQuantityRollup", +"description": "Total carbohydrate rollup." +}, +"totalFat": { +"$ref": "WeightQuantityRollup", +"description": "Total fat rollup." +} +}, +"type": "object" +}, +"ObservationSampleTime": { +"description": "Represents a sample time of an observed data point.", +"id": "ObservationSampleTime", +"properties": { +"civilTime": { +"$ref": "CivilDateTime", +"description": "Output only. The civil time in the timezone the subject is in at the time of the observation.", +"readOnly": true +}, +"physicalTime": { +"description": "Required. The time of the observation.", +"format": "google-datetime", +"type": "string" +}, +"utcOffset": { +"description": "Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"ObservationTimeInterval": { +"description": "Represents a time interval of an observed data point.", +"id": "ObservationTimeInterval", +"properties": { +"civilEndTime": { +"$ref": "CivilDateTime", +"description": "Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval", +"readOnly": true +}, +"civilStartTime": { +"$ref": "CivilDateTime", +"description": "Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval", +"readOnly": true +}, +"endTime": { +"description": "Required. Observed interval end time.", +"format": "google-datetime", +"type": "string" +}, +"endUtcOffset": { +"description": "Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +}, +"startTime": { +"description": "Required. Observed interval start time.", +"format": "google-datetime", +"type": "string" +}, +"startUtcOffset": { +"description": "Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +} +}, +"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" +}, +"OutOfBedSegment": { +"description": "A time interval to represent an out-of-bed segment.", +"id": "OutOfBedSegment", +"properties": { +"endTime": { +"description": "Required. Segment end time.", +"format": "google-datetime", +"type": "string" +}, +"endUtcOffset": { +"description": "Required. The offset of the user's local time at the end of the segment relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +}, +"startTime": { +"description": "Required. Segment tart time.", +"format": "google-datetime", +"type": "string" +}, +"startUtcOffset": { +"description": "Required. The offset of the user's local time at the start of the segment relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +} +}, +"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", +"properties": { +"percentage": { +"description": "Required. The oxygen saturation percentage. Valid values are from 0 to 100.", +"format": "double", +"type": "number" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which oxygen saturation was measured." +} +}, +"type": "object" +}, +"PairedDevice": { +"description": "User's Paired 1P Device The PairedDevice details include information about the device type, battery status, battery level, last sync time, device version, mac address, and features.", +"id": "PairedDevice", +"properties": { +"batteryLevel": { +"description": "Output only. The battery level of the device.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"batteryStatus": { +"description": "Output only. The battery status of the device. Supported: High | Medium | Low | Empty", +"readOnly": true, +"type": "string" +}, +"deviceType": { +"description": "Output only. The device type. Supported: TRACKER | SCALE", +"enum": [ +"DEVICE_TYPE_UNSPECIFIED", +"TRACKER", +"SCALE" +], +"enumDescriptions": [ +"Device type is not specified.", +"Device type is tracker.", +"Device type is scale." +], +"readOnly": true, +"type": "string" +}, +"deviceVersion": { +"description": "Output only. The product name of the device", +"readOnly": true, +"type": "string" +}, +"features": { +"description": "Output only. Lists of unique features supported by the device. Comprehensive list of supported features: **Fitness Tracking** - `ACTIVE_MINUTES`: Legacy active minutes. - `AUTOSTRIDE`: Automatic stride length calculation. - `BIKE_ONBOARDING`: Cycling UI support. - `CALORIES`: Daily burned calories. - `DISTANCE`: Daily distance tracking. - `ELEVATION`: Floors climbed. - `INACTIVITY_ALERTS`: Reminders to move. - `SEDENTARY_TIME`: Tracks inactive time. - `STEPS`: Daily steps. - `SWIM`: Swim tracking (laps/strokes). - `AUTORUN`: Automatic run detection. - `ACTIVE_ZONE_MINUTES`: Active Zone Minutes (AZM). **Heart Rate & Health** - `HEART_RATE`: Continuous heart rate (PPG). - `BAT_SIGNAL`: High/Low Heart Rate Alerts. **Advanced Sensors** - `SPO2`: Blood oxygen saturation. - `NIGHTTIME_OXYGEN_SATURATION`: Sleep SpO2. - `ESTIMATED_OXYGEN_VARIATION`: Estimated Oxygen Variation. - `EDA`: Electrodermal Activity (stress). - `SKIN_TEMPERATURE`: Skin temperature variation. - `INTERNAL_DEVICE_TEMPERATURE`: Internal device temperature. **Sleep & Wellness** - `SLEEP`: Basic sleep tracking. - `SMART_SLEEP`: Advanced sleep tracking (stages/score). - `BEDTIME_REMINDER`: Bedtime reminders. - `SOUNDSCAPE`: Snore and noise detection. **Advanced Workouts** - `WB`: Custom Workout Builder. - `AUTOCUES`: Auto Cues / Auto Lap. - `DWR_RUN`: Daily Run Recommendations. - `ADVANCED_RUNNING`: Advanced Running Dynamics (e.g., GCT, VO). **GPS & Location** - `GPS`: Built-in GPS. - `CONNECTED_GPS`: Connected GPS (uses phone). - `LOCATION_HINT`: Location helper. **Payments & NFC** - `PAYMENTS`: NFC payments (Fitbit Pay/Google Wallet). - `FELICA`: FeliCa support (Japan payments/transit). **Activity Detection** - `GROK`: SmartTrack automatic activity detection. - `RETRO_AR`: Retroactive Activity Recognition prompts. **Smart Features & UI** - `ALARMS`: Silent alarms. - `BLE_MUSIC_CONTROL`: BLE music control. - `MUSIC`: Direct music storage/control. - `YOUTUBE_MUSIC_SUPPORTED`: YouTube Music support. - `GALLERY`: App Gallery. - `TUTORIAL_SUPPORTED`: On-screen tutorials. - `SMILEY_EMOTE`: Legacy Zip face. - `MOBILE_TO_DEVICE_DEEPLINK`: Mobile to device settings deep link. - `HIDE_GALLERY`: Option to hide Gallery. - `HIDE_GOAL_SELECTION`: Option to hide goal selection. - `DIGITAL_WARRANTY_SUPPORTED`: Digital warranty display. - `DIRECT_DEVICE_SETTINGS_SUPPORTED`: Direct device settings management. **Gym HR Broadcasting** - `ASPEN_SUPPORTED`: Broadcast HR to gym equipment. - `ASPEN_REMOTE_UI_SUPPORTED`: Remote UI for HR sharing. **Privacy & Security** - `FINITE_IMPROBABILITY`: BLE Resolvable Private Address (RPA) privacy. - `DOMAIN_KEY_SYNC`: Domain key synchronization. **BLE Protocol** - `BONDING`: Secure BLE bonding. - `ADVERTISES_SERIAL`: Advertises serial number. - `STATUS_CHARACTERISTIC`: BLE Status Characteristic. - `TRACKER_CHANNEL_CHARACTERISTIC`: BLE Tracker Channel Characteristic. - `PING_CHARACTERISTIC`: BLE Ping Characteristic. **Cellular & Wi-Fi** - `MOBILE_DATA`: LTE cellular support. - `SINGLE_AP_WIFI`: Single AP Wi-Fi. - `MULTI_AP_WIFI`: Multi AP Wi-Fi. - `WIFI_FWUP`: Firmware updates over Wi-Fi. **Data Sync & Transfer** - `APP_SYNC`: Background app sync. - `LIVE_DATA`: Real-time data streaming. - `EVENT_BASED_SYNC_SUPPORTED`: Event-based sync. - `TIME_SERVICE`: Time synchronization service. - `REMOTE_FILE_PROVIDER`: Remote file transfer. - `DIRECT_COMMS_ALARMS`: Direct communication for alarms. - `DIRECT_COMMS_EXERCISE`: Direct communication for exercise. - `DIRECT_COMMS_BATTERY_ALERTS`: Direct communication for battery alerts. **Google Integrations** - `PARROT_TREE_SUPPORTED`: Find My Device support.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"lastSyncTime": { +"description": "Output only. The time of last sync with the Fitbit mobile application.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"macAddress": { +"description": "Output only. Mac ID number of the device.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of this Device resource. Format: `users/{user}/pairedDevices/{paired_device}` Example: `users/1234567890/pairedDevices/123` or `users/me/pairedDevices/123`", +"type": "string" +} +}, +"type": "object" +}, +"Profile": { +"description": "Profile details.", +"id": "Profile", +"properties": { +"age": { +"description": "Optional. The age in years based on the user's birth date. Updates to this field are currently not supported.", +"format": "int32", +"type": "integer" +}, +"autoRunningStrideLengthMm": { +"description": "Output only. The automatically calculated running stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"autoWalkingStrideLengthMm": { +"description": "Output only. The automatically calculated walking stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"membershipStartDate": { +"$ref": "Date", +"description": "Output only. The date the user created their account. Updates to this field are currently not supported.", +"readOnly": true +}, +"name": { +"description": "Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.", +"type": "string" +}, +"userConfiguredRunningStrideLengthMm": { +"description": "Optional. The user's user configured running stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`", +"format": "int32", +"type": "integer" +}, +"userConfiguredWalkingStrideLengthMm": { +"description": "Optional. The user's user configured walking stride length, in millimeters. The user must consent to the following access scope to access this field: - `https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"ReconcileDataPointsResponse": { +"description": "Response containing the list of reconciled DataPoints.", +"id": "ReconcileDataPointsResponse", +"properties": { +"dataPoints": { +"description": "Data points matching the query", +"items": { +"$ref": "ReconciledDataPoint" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Next page token, empty if the response is complete", +"type": "string" +} +}, +"type": "object" +}, +"ReconciledDataPoint": { +"description": "A reconciled computed or recorded metric.", +"id": "ReconciledDataPoint", +"properties": { +"activeEnergyBurned": { +"$ref": "ActiveEnergyBurned", +"description": "Data for points in the `active-energy-burned` interval data type collection." +}, +"activeMinutes": { +"$ref": "ActiveMinutes", +"description": "Data for points in the `active-minutes` interval data type collection." +}, +"activeZoneMinutes": { +"$ref": "ActiveZoneMinutes", +"description": "Data for points in the `active-zone-minutes` interval data type collection, measured in minutes." +}, +"activityLevel": { +"$ref": "ActivityLevel", +"description": "Data for points in the `activity-level` daily data type collection." +}, +"altitude": { +"$ref": "Altitude", +"description": "Data for points in the `altitude` interval data type collection." +}, +"basalEnergyBurned": { +"$ref": "BasalEnergyBurned", +"description": "Data for points in the `basal-energy-burned` interval data type collection." +}, +"bloodGlucose": { +"$ref": "BloodGlucose", +"description": "Data for points in the `blood-glucose` sample data type collection." +}, +"bodyFat": { +"$ref": "BodyFat", +"description": "Data for points in the `body-fat` sample data type collection." +}, +"coreBodyTemperature": { +"$ref": "CoreBodyTemperature", +"description": "Data for points in the `core-body-temperature` sample data type collection." +}, +"dailyHeartRateVariability": { +"$ref": "DailyHeartRateVariability", +"description": "Data for points in the `daily-heart-rate-variability` daily data type collection." +}, +"dailyHeartRateZones": { +"$ref": "DailyHeartRateZones", +"description": "Data for points in the `daily-heart-rate-zones` daily data type collection." +}, +"dailyOxygenSaturation": { +"$ref": "DailyOxygenSaturation", +"description": "Data for points in the `daily-oxygen-saturation` daily data type collection." +}, +"dailyRespiratoryRate": { +"$ref": "DailyRespiratoryRate", +"description": "Data for points in the `daily-respiratory-rate` daily data type collection." +}, +"dailyRestingHeartRate": { +"$ref": "DailyRestingHeartRate", +"description": "Data for points in the `daily-resting-heart-rate` daily data type collection." +}, +"dailySleepTemperatureDerivations": { +"$ref": "DailySleepTemperatureDerivations", +"description": "Data for points in the `daily-sleep-temperature-derivations` daily data type collection." +}, +"dailyVo2Max": { +"$ref": "DailyVO2Max", +"description": "Data for points in the `daily-vo2-max` daily data type collection." +}, +"dataPointName": { +"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" +}, +"distance": { +"$ref": "Distance", +"description": "Data for points in the `distance` interval data type collection." +}, +"exercise": { +"$ref": "Exercise", +"description": "Data for points in the `exercise` session data type collection." +}, +"floors": { +"$ref": "Floors", +"description": "Data for points in the `floors` interval data type collection." +}, +"heartRate": { +"$ref": "HeartRate", +"description": "Data for points in the `heart-rate` sample data type collection." +}, +"heartRateVariability": { +"$ref": "HeartRateVariability", +"description": "Data for points in the `heart-rate-variability` sample data type collection." +}, +"height": { +"$ref": "Height", +"description": "Data for points in the `height` sample data type collection." +}, +"hydrationLog": { +"$ref": "HydrationLog", +"description": "Data for points in the `hydration-log` session data type collection." +}, +"nutritionLog": { +"$ref": "NutritionLog", +"description": "Data for points in the `nutrition-log` session data type collection." +}, +"oxygenSaturation": { +"$ref": "OxygenSaturation", +"description": "Data for points in the `oxygen-saturation` sample data type collection." +}, +"respiratoryRateSleepSummary": { +"$ref": "RespiratoryRateSleepSummary", +"description": "Data for points in the `respiratory-rate-sleep-summary` sample data type collection." +}, +"runVo2Max": { +"$ref": "RunVO2Max", +"description": "Data for points in the `run-vo2-max` sample data type collection." +}, +"sedentaryPeriod": { +"$ref": "SedentaryPeriod", +"description": "Data for points in the `sedentary-period` interval data type collection." +}, +"sleep": { +"$ref": "Sleep", +"description": "Data for points in the `sleep` session data type collection." +}, +"steps": { +"$ref": "Steps", +"description": "Data for points in the `steps` interval data type collection." +}, +"swimLengthsData": { +"$ref": "SwimLengthsData", +"description": "Data for points in the `swim-lengths-data` interval data type collection." +}, +"timeInHeartRateZone": { +"$ref": "TimeInHeartRateZone", +"description": "Data for points in the `time-in-heart-rate-zone` interval data type collection." +}, +"vo2Max": { +"$ref": "VO2Max", +"description": "Data for points in the `vo2-max` sample data type collection." +}, +"weight": { +"$ref": "Weight", +"description": "Data for points in the `weight` sample data type collection." +} +}, +"type": "object" +}, +"RespiratoryRateSleepSummary": { +"description": "Records respiratory rate details during sleep. Can have multiple per day if the user sleeps multiple times.", +"id": "RespiratoryRateSleepSummary", +"properties": { +"deepSleepStats": { +"$ref": "RespiratoryRateSleepSummaryStatistics", +"description": "Optional. Respiratory rate statistics for deep sleep." +}, +"fullSleepStats": { +"$ref": "RespiratoryRateSleepSummaryStatistics", +"description": "Required. Full respiratory rate statistics." +}, +"lightSleepStats": { +"$ref": "RespiratoryRateSleepSummaryStatistics", +"description": "Optional. Respiratory rate statistics for light sleep." +}, +"remSleepStats": { +"$ref": "RespiratoryRateSleepSummaryStatistics", +"description": "Optional. Respiratory rate statistics for REM sleep." +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which respiratory rate was measured." +} +}, +"type": "object" +}, +"RespiratoryRateSleepSummaryStatistics": { +"description": "Respiratory rate statistics for a given sleep stage.", +"id": "RespiratoryRateSleepSummaryStatistics", +"properties": { +"breathsPerMinute": { +"description": "Required. Average breaths per minute.", +"format": "double", +"type": "number" +}, +"signalToNoise": { +"description": "Optional. How trustworthy the data is for the computation.", +"format": "double", +"type": "number" +}, +"standardDeviation": { +"description": "Optional. Standard deviation of the respiratory rate during sleep.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"RestingHeartRatePersonalRangeRollupValue": { +"description": "Represents the rollup value for the daily resting heart rate data type.", +"id": "RestingHeartRatePersonalRangeRollupValue", +"properties": { +"beatsPerMinuteMax": { +"description": "The upper bound of the user's daily resting heart rate personal range.", +"format": "double", +"type": "number" +}, +"beatsPerMinuteMin": { +"description": "The lower bound of the user's daily resting heart rate personal range.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"RollUpDataPointsRequest": { +"description": "Request to roll up data points by physical time intervals.", +"id": "RollUpDataPointsRequest", +"properties": { +"dataSourceFamily": { +"description": "Optional. The data source family name to roll up. If empty, data points from all available data sources will be rolled up. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/me/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/me/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect.", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.", +"type": "string" +}, +"range": { +"$ref": "Interval", +"description": "Required. Closed-open range of data points that will be rolled up. The maximum range for `calories-in-heart-rate-zone`, `heart-rate`, `active-minutes` and `total-calories` is 14 days. The maximum range for all other data types is 90 days." +}, +"windowSize": { +"description": "Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second. If the requested range is not an exact multiple of `window_size`, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than `window_size`.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"RollUpDataPointsResponse": { +"description": "Response containing the list of rolled up data points.", +"id": "RollUpDataPointsResponse", +"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" +}, +"rollupDataPoints": { +"description": "Values for each aggregation time window.", +"items": { +"$ref": "RollupDataPoint" +}, +"type": "array" +} +}, +"type": "object" +}, +"RollupDataPoint": { +"description": "Value of a rollup for a single physical time interval (aggregation window) of reconciled data points from all data sources, excluding those data points that are identified as recorded by wearables in intervals when they were not actually worn.", +"id": "RollupDataPoint", +"properties": { +"activeEnergyBurned": { +"$ref": "ActiveEnergyBurnedRollupValue", +"description": "Returned by default when rolling up data points from the `active-energy-burned` data type." +}, +"activeMinutes": { +"$ref": "ActiveMinutesRollupValue", +"description": "Returned by default when rolling up data points from the `active-minutes` data type, or when requested explicitly using the `active-minutes` rollup type identifier." +}, +"activeZoneMinutes": { +"$ref": "ActiveZoneMinutesRollupValue", +"description": "Returned by default when rolling up data points from the `active-zone-minutes` data type, or when requested explicitly using the `active-zone-minutes` rollup type identifier." +}, +"activityLevel": { +"$ref": "ActivityLevelRollupValue", +"description": "Returned by default when rolling up data points from the `activity-level` data type, or when requested explicitly using the `activity-level` rollup type identifier." +}, +"altitude": { +"$ref": "AltitudeRollupValue", +"description": "Returned by default when rolling up data points from the `altitude` data type, or when requested explicitly using the `altitude` rollup type identifier." +}, +"bloodGlucose": { +"$ref": "BloodGlucoseRollupValue", +"description": "Returned by default when rolling up data points from the `blood-glucose` data type." +}, +"bodyFat": { +"$ref": "BodyFatRollupValue", +"description": "Returned by default when rolling up data points from the `body-fat` data type, or when requested explicitly using the `body-fat` rollup type identifier." +}, +"caloriesInHeartRateZone": { +"$ref": "CaloriesInHeartRateZoneRollupValue", +"description": "Returned by default when rolling up data points from the `calories-in-heart-rate-zone` data type, or when requested explicitly using the `calories-in-heart-rate-zone` rollup type identifier." +}, +"coreBodyTemperature": { +"$ref": "CoreBodyTemperatureRollupValue", +"description": "Returned by default when rolling up data points from the `core-body-temperature` data type, or when requested explicitly using the `core-body-temperature` rollup type identifier." +}, +"distance": { +"$ref": "DistanceRollupValue", +"description": "Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier." +}, +"endTime": { +"description": "End time of the window this value aggregates over", +"format": "google-datetime", +"type": "string" +}, +"floors": { +"$ref": "FloorsRollupValue", +"description": "Returned by default when rolling up data points from the `floors` data type, or when requested explicitly using the `floors` rollup type identifier." +}, +"heartRate": { +"$ref": "HeartRateRollupValue", +"description": "Returned by default when rolling up data points from the `heart-rate` data type, or when requested explicitly using the `heart-rate` rollup type identifier." +}, +"hydrationLog": { +"$ref": "HydrationLogRollupValue", +"description": "Returned by default when rolling up data points from the `hydration-log` data type, or when requested explicitly using the `hydration-log` rollup type identifier." +}, +"nutritionLog": { +"$ref": "NutritionLogRollupValue", +"description": "Returned by default when rolling up data points from the `nutrition-log` data type, or when requested explicitly using the `nutrition-log` rollup type identifier." +}, +"runVo2Max": { +"$ref": "RunVO2MaxRollupValue", +"description": "Returned by default when rolling up data points from the `run-vo2-max` data type, or when requested explicitly using the `run-vo2-max` rollup type identifier." +}, +"sedentaryPeriod": { +"$ref": "SedentaryPeriodRollupValue", +"description": "Returned by default when rolling up data points from the `sedentary-period` data type, or when requested explicitly using the `sedentary-period` rollup type identifier." +}, +"startTime": { +"description": "Start time of the window this value aggregates over", +"format": "google-datetime", +"type": "string" +}, +"steps": { +"$ref": "StepsRollupValue", +"description": "Returned by default when rolling up data points from the `steps` data type, or when requested explicitly using the `steps` rollup type identifier." +}, +"swimLengthsData": { +"$ref": "SwimLengthsDataRollupValue", +"description": "Returned by default when rolling up data points from the `swim-lengths-data` data type, or when requested explicitly using the `swim-lengths-data` rollup type identifier." +}, +"timeInHeartRateZone": { +"$ref": "TimeInHeartRateZoneRollupValue", +"description": "Returned by default when rolling up data points from the `time-in-heart-rate-zone` data type, or when requested explicitly using the `time-in-heart-rate-zone` rollup type identifier." +}, +"totalCalories": { +"$ref": "TotalCaloriesRollupValue", +"description": "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." +}, +"weight": { +"$ref": "WeightRollupValue", +"description": "Returned by default when rolling up data points from the `weight` data type, or when requested explicitly using the `weight` rollup type identifier." +} +}, +"type": "object" +}, +"RunVO2Max": { +"description": "VO2 max value calculated based on the user's running activity. Value stored in ml/kg/min.", +"id": "RunVO2Max", +"properties": { +"runVo2Max": { +"description": "Required. Run VO2 max value in ml/kg/min.", +"format": "double", +"type": "number" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which the metric was measured." +} +}, +"type": "object" +}, +"RunVO2MaxRollupValue": { +"description": "Represents the result of the rollup of the user's daily heart rate variability personal range.", +"id": "RunVO2MaxRollupValue", +"properties": { +"rateAvg": { +"description": "Average value of run VO2 max in the interval.", +"format": "double", +"type": "number" +}, +"rateMax": { +"description": "Maximum value of run VO2 max in the interval.", +"format": "double", +"type": "number" +}, +"rateMin": { +"description": "Minimum value of run VO2 max in the interval..", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"SedentaryPeriod": { +"description": "SedentaryPeriod SedentaryPeriod data represents the periods of time that the user was sedentary (i.e. not moving while wearing the device).", +"id": "SedentaryPeriod", +"properties": { +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +} +}, +"type": "object" +}, +"SedentaryPeriodRollupValue": { +"description": "Represents the result of the rollup of the user's sedentary periods.", +"id": "SedentaryPeriodRollupValue", +"properties": { +"durationSum": { +"description": "The total time user spent sedentary during the interval.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"Serving": { +"description": "Represents different properties and information about the serving of a specific food.", +"id": "Serving", +"properties": { +"amount": { +"description": "Optional. The number of servings.", +"format": "double", +"type": "number" +}, +"foodMeasurementUnit": { +"description": "Required. Food measurement unit", +"type": "string" +}, +"foodMeasurementUnitDisplayName": { +"description": "Output only. Legacy measurement unit for serving size in singular form (e.g. \"piece\", \"gram\").", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SessionTimeInterval": { +"description": "Represents a time interval of session data point, which bundles multiple observed metrics together.", +"id": "SessionTimeInterval", +"properties": { +"civilEndTime": { +"$ref": "CivilDateTime", +"description": "Output only. Session end time in civil time in the timezone the subject is in at the end of the session.", +"readOnly": true +}, +"civilStartTime": { +"$ref": "CivilDateTime", +"description": "Output only. Session start time in civil time in the timezone the subject is in at the start of the session.", +"readOnly": true +}, +"endTime": { +"description": "Required. The end time of the observed session.", +"format": "google-datetime", +"type": "string" +}, +"endUtcOffset": { +"description": "Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +}, +"startTime": { +"description": "Required. The start time of the observed session.", +"format": "google-datetime", +"type": "string" +}, +"startUtcOffset": { +"description": "Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"Settings": { +"description": "Settings details.", +"id": "Settings", +"properties": { +"autoStrideEnabled": { +"description": "Optional. True if the user's stride length is determined automatically. Updates to this field are currently not supported.", +"type": "boolean" +}, +"distanceUnit": { +"description": "Optional. The measurement unit defined in the user's account settings.", +"enum": [ +"DISTANCE_UNIT_UNSPECIFIED", +"DISTANCE_UNIT_MILES", +"DISTANCE_UNIT_KILOMETERS" +], +"enumDescriptions": [ +"Distance unit is not specified.", +"Distance unit is miles.", +"Distance unit is kilometers." +], +"type": "string" +}, +"foodLanguageCode": { +"description": "Output only. The food language code derived from the user's food database. Possible values: `'en-US'`, `'en-GB'`, `'de-DE'`, `'es-ES'`, `'fr-FR'`, `'zh-CN'`, `'zh-TW'`, `'ja-JP'`, `'en-AU'`, `'en-CA'`, `'it-IT'`, `'ko-KR'`, `'es-MX'`, `'en-IN'`, `'en-SG'`, `'en-PH'`, `'en-IE'`, `'fr-CA'`. Updates to this field are currently not supported.", +"readOnly": true, +"type": "string" +}, +"glucoseUnit": { +"description": "Optional. The measurement unit defined in the user's account settings.", +"enum": [ +"GLUCOSE_UNIT_UNSPECIFIED", +"GLUCOSE_UNIT_MG_DL", +"GLUCOSE_UNIT_MMOL_L" +], +"enumDescriptions": [ +"Glucose unit is not specified.", +"Glucose unit is mg/dL.", +"Glucose unit is mmol/l." +], +"type": "string" +}, +"heightUnit": { +"description": "Optional. The measurement unit defined in the user's account settings.", +"enum": [ +"HEIGHT_UNIT_UNSPECIFIED", +"HEIGHT_UNIT_INCHES", +"HEIGHT_UNIT_CENTIMETERS" +], +"enumDescriptions": [ +"Height unit is not specified.", +"Height unit is inches.", +"Height unit is cm." +], +"type": "string" +}, +"languageLocale": { +"description": "Optional. The locale defined in the user's account settings. Updates to this field are currently not supported.", +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of this Settings resource. Format: `users/{user}/settings` Example: `users/1234567890/settings` or `users/me/settings` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.", +"type": "string" +}, +"strideLengthRunningType": { +"description": "Optional. The stride length type defined in the user's account settings for running. Updates to this field are currently not supported.", +"enum": [ +"STRIDE_LENGTH_TYPE_UNSPECIFIED", +"STRIDE_LENGTH_TYPE_DEFAULT", +"STRIDE_LENGTH_TYPE_MANUAL", +"STRIDE_LENGTH_TYPE_AUTO" +], +"enumDescriptions": [ +"Stride length type is not specified.", +"Stride length type is computed based on the user's gender and height.", +"Stride length type is manually set by the user.", +"Stride length type is determined automatically." +], +"type": "string" +}, +"strideLengthWalkingType": { +"description": "Optional. The stride length type defined in the user's account settings for walking. Updates to this field are currently not supported.", +"enum": [ +"STRIDE_LENGTH_TYPE_UNSPECIFIED", +"STRIDE_LENGTH_TYPE_DEFAULT", +"STRIDE_LENGTH_TYPE_MANUAL", +"STRIDE_LENGTH_TYPE_AUTO" +], +"enumDescriptions": [ +"Stride length type is not specified.", +"Stride length type is computed based on the user's gender and height.", +"Stride length type is manually set by the user.", +"Stride length type is determined automatically." +], +"type": "string" +}, +"swimUnit": { +"description": "Optional. The measurement unit defined in the user's account settings.", +"enum": [ +"SWIM_UNIT_UNSPECIFIED", +"SWIM_UNIT_METERS", +"SWIM_UNIT_YARDS" +], +"enumDescriptions": [ +"Swim unit is not specified.", +"Swim unit is meters.", +"Swim unit is yards." +], +"type": "string" +}, +"temperatureUnit": { +"description": "Optional. The measurement unit defined in the user's account settings.", +"enum": [ +"TEMPERATURE_UNIT_UNSPECIFIED", +"TEMPERATURE_UNIT_CELSIUS", +"TEMPERATURE_UNIT_FAHRENHEIT" +], +"enumDescriptions": [ +"Temperature unit is not specified.", +"Temperature unit is Celsius.", +"Temperature unit is Fahrenheit." +], +"type": "string" +}, +"timeZone": { +"description": "Optional. The timezone defined in the user's account settings. This follows the IANA [Time Zone Database](https://www.iana.org/time-zones). Updates to this field are currently not supported.", +"type": "string" +}, +"utcOffset": { +"description": "Optional. The user's timezone offset relative to UTC. Updates to this field are currently not supported.", +"format": "google-duration", +"type": "string" +}, +"waterUnit": { +"description": "Optional. The measurement unit defined in the user's account settings.", +"enum": [ +"WATER_UNIT_UNSPECIFIED", +"WATER_UNIT_ML", +"WATER_UNIT_FL_OZ", +"WATER_UNIT_CUP" +], +"enumDescriptions": [ +"Water unit is not specified.", +"Water unit is milliliters.", +"Water unit is fluid ounces.", +"Water unit is cups." +], +"type": "string" +}, +"weightUnit": { +"description": "Optional. The measurement unit defined in the user's account settings.", +"enum": [ +"WEIGHT_UNIT_UNSPECIFIED", +"WEIGHT_UNIT_POUNDS", +"WEIGHT_UNIT_STONE", +"WEIGHT_UNIT_KILOGRAMS" +], +"enumDescriptions": [ +"Weight unit is not specified.", +"Weight unit is pounds.", +"Weight unit is stones.", +"Weight unit is kilograms." +], +"type": "string" +} +}, +"type": "object" +}, +"Sleep": { +"description": "A sleep session possibly including stages.", +"id": "Sleep", +"properties": { +"createTime": { +"description": "Output only. Creation time of this sleep observation.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"interval": { +"$ref": "SessionTimeInterval", +"description": "Required. Observed sleep interval." +}, +"metadata": { +"$ref": "SleepMetadata", +"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.", +"items": { +"$ref": "OutOfBedSegment" +}, +"type": "array" +}, +"shortAwakenings": { +"description": "Output only. List of short awake segments (under a set threshold) that are part of the sleep session. These can overlap with sleep stages.", +"items": { +"$ref": "SleepStage" +}, +"readOnly": true, +"type": "array" +}, +"stages": { +"description": "Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.", +"items": { +"$ref": "SleepStage" +}, +"type": "array" +}, +"summary": { +"$ref": "SleepSummary", +"description": "Output only. Sleep summary: metrics and stages summary.", +"readOnly": true +}, +"type": { +"description": "Optional. SleepType: classic or stages.", +"enum": [ +"SLEEP_TYPE_UNSPECIFIED", +"CLASSIC", +"STAGES" +], +"enumDescriptions": [ +"Sleep type is unspecified.", +"Classic sleep is a sleep with 3 stages types: AWAKE, RESTLESS and ASLEEP.", +"On top of \"classic\" sleep stages an additional processing pass can calculate stages more precisely, overwriting the prior stages with AWAKE, LIGHT, REM and DEEP." +], +"type": "string" +}, +"updateTime": { +"description": "Output only. Last update time of this sleep observation.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SleepMetadata": { +"description": "Additional information about how the sleep was processed.", +"id": "SleepMetadata", +"properties": { +"externalId": { +"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, +"type": "boolean" +}, +"nap": { +"description": "Output only. Naps are sleeps without stages and relatively short durations.", +"readOnly": true, +"type": "boolean" +}, +"processed": { +"description": "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.", +"readOnly": true, +"type": "boolean" +}, +"stagesStatus": { +"description": "Output only. Sleep stages algorithm processing status.", +"enum": [ +"STAGES_STATE_UNSPECIFIED", +"REJECTED_COVERAGE", +"REJECTED_MAX_GAP", +"REJECTED_START_GAP", +"REJECTED_END_GAP", +"REJECTED_NAP", +"REJECTED_SERVER", +"TIMEOUT", +"SUCCEEDED", +"PROCESSING_INTERNAL_ERROR" +], +"enumDescriptions": [ +"Output only. Sleep stages status is unspecified.", +"Output only. Sleep stages cannot be computed due to low RR coverage.", +"Output only. Sleep stages cannot be computed due to the large middle gap (2h).", +"Output only. Sleep stages cannot be computed due to the large start gap (1h).", +"Output only. Sleep stages cannot be computed due to the large end gap (1h).", +"Output only. Sleep stages cannot be computed because the sleep log is a nap (has < 3h duration).", +"Output only. Sleep stages cannot be computed because input data is not available (PPGV2, wake magnitude, etc).", +"Output only. Sleep stages cannot be computed due to server timeout.", +"Output only. Sleep stages successfully computed.", +"Output only. Sleep stages cannot be computed due to server internal error." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SleepStage": { +"description": "Sleep stage segment.", +"id": "SleepStage", +"properties": { +"createTime": { +"description": "Output only. Creation time of this sleep stages segment.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Required. Sleep stage end time.", +"format": "google-datetime", +"type": "string" +}, +"endUtcOffset": { +"description": "Required. The offset of the user's local time at the end of the sleep stage relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +}, +"startTime": { +"description": "Required. Sleep stage start time.", +"format": "google-datetime", +"type": "string" +}, +"startUtcOffset": { +"description": "Required. The offset of the user's local time at the start of the sleep stage relative to the Coordinated Universal Time (UTC).", +"format": "google-duration", +"type": "string" +}, +"type": { +"description": "Required. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.", +"enum": [ +"SLEEP_STAGE_TYPE_UNSPECIFIED", +"AWAKE", +"LIGHT", +"DEEP", +"REM", +"ASLEEP", +"RESTLESS" +], +"enumDescriptions": [ +"The default unset value.", +"Sleep stage AWAKE.", +"Sleep stage LIGHT.", +"Sleep stage DEEP.", +"Sleep stage REM.", +"Sleep stage ASLEEP.", +"Sleep stage RESTLESS." +], +"type": "string" +}, +"updateTime": { +"description": "Output only. Last update time of this sleep stages segment.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SleepSummary": { +"description": " Sleep summary: metrics and stages summary.", +"id": "SleepSummary", +"properties": { +"minutesAfterWakeUp": { +"description": "Output only. Minutes after wake up calculated by restlessness algorithm.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"minutesAsleep": { +"description": "Output only. Total number of minutes asleep. For classic sleep it is the sum of ASLEEP stages (excluding AWAKE and RESTLESS). For \"stages\" sleep it is the sum of LIGHT, REM and DEEP stages (excluding AWAKE).", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"minutesAwake": { +"description": "Output only. Total number of minutes awake. It is a sum of all AWAKE stages.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"minutesInSleepPeriod": { +"description": "Output only. Delta between wake time and bedtime. It is the sum of all stages.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"minutesToFallAsleep": { +"description": "Output only. Minutes to fall asleep calculated by restlessness algorithm.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"stagesSummary": { +"description": "Output only. List of summaries (total duration and segment count) per each sleep stage type.", +"items": { +"$ref": "StageSummary" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"SplitSummary": { +"description": "Represents splits or laps recorded within an exercise. Lap events partition a workout into segments based on criteria like distance, time, or calories.", +"id": "SplitSummary", +"properties": { +"activeDuration": { +"description": "Output only. Lap time excluding the pauses.", +"format": "google-duration", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Required. Lap end time", +"format": "google-datetime", +"type": "string" +}, +"endUtcOffset": { +"description": "Required. Lap end time offset from UTC", +"format": "google-duration", +"type": "string" +}, +"metricsSummary": { +"$ref": "MetricsSummary", +"description": "Required. Summary metrics for this split." +}, +"splitType": { +"description": "Required. Method used to split the exercise laps. Users may manually mark the lap as complete even if the tracking is automatic.", +"enum": [ +"SPLIT_TYPE_UNSPECIFIED", +"MANUAL", +"DURATION", +"DISTANCE", +"CALORIES" +], +"enumDescriptions": [ +"Split type is unspecified.", +"Manual split.", +"Split by duration.", +"Split by distance.", +"Split by calories." +], +"type": "string" +}, +"startTime": { +"description": "Required. Lap start time", +"format": "google-datetime", +"type": "string" +}, +"startUtcOffset": { +"description": "Required. Lap start time offset from UTC", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"StageSummary": { +"description": "Total duration and segment count for a stage.", +"id": "StageSummary", +"properties": { +"count": { +"description": "Output only. Number of sleep stages segments.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"minutes": { +"description": "Output only. Total duration in minutes of a sleep stage.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"type": { +"description": "Output only. Sleep stage type: AWAKE, DEEP, REM, LIGHT etc.", +"enum": [ +"SLEEP_STAGE_TYPE_UNSPECIFIED", +"AWAKE", +"LIGHT", +"DEEP", +"REM", +"ASLEEP", +"RESTLESS" +], +"enumDescriptions": [ +"The default unset value.", +"Sleep stage AWAKE.", +"Sleep stage LIGHT.", +"Sleep stage DEEP.", +"Sleep stage REM.", +"Sleep stage ASLEEP.", +"Sleep stage RESTLESS." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Status": { +"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", +"id": "Status", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", +"type": "string" +} +}, +"type": "object" +}, +"Steps": { +"description": "Step count over the time interval.", +"id": "Steps", +"properties": { +"count": { +"description": "Required. Number of steps in the recorded interval.", +"format": "int64", +"type": "string" +}, +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +} +}, +"type": "object" +}, +"StepsRollupValue": { +"description": "Represents the result of the rollup of the steps data type.", +"id": "StepsRollupValue", +"properties": { +"countSum": { +"description": "Total number of steps in the interval.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"Subscriber": { +"description": "-- Resource Messages -- A subscriber receives notifications from Google Health API.", +"id": "Subscriber", +"properties": { +"createTime": { +"description": "Output only. The time at which the subscriber was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endpointAuthorization": { +"$ref": "EndpointAuthorization", +"description": "Required. Authorization mechanism for a subscriber endpoint. This is required to ensure the endpoint can be verified." +}, +"endpointUri": { +"description": "Required. The full HTTPS URI where update notifications will be sent. The URI must be a valid URL and use HTTPS as the scheme. This endpoint will be verified during CreateSubscriber and UpdateSubscriber calls. See RPC documentation for verification details.", +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the Subscriber. Format: projects/{project}/subscribers/{subscriber} The {project} ID is a Google Cloud Project ID or Project Number. The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise (e.g., a UUID). Example (User-settable subscriber ID): projects/my-project/subscribers/my-sub-123 Example (System-generated subscriber ID): projects/my-project/subscribers/a1b2c3d4-e5f6-7890-1234-567890abcdef", +"type": "string" +}, +"state": { +"description": "Output only. The state of the subscriber.", +"enum": [ +"STATE_UNSPECIFIED", +"UNVERIFIED", +"ACTIVE", +"INACTIVE" +], +"enumDescriptions": [ +"Represents an unspecified subscriber state.", +"Represents an unverified subscriber. This is the initial state of the subscriber when it is created. The backend will verify the subscriber's endpoint_uri.", +"Represents an active subscriber. The endpoint has been verified.", +"Represents an inactive subscriber." +], +"readOnly": true, +"type": "string" +}, +"subscriberConfigs": { +"description": "Optional. Configuration for the subscriber.", +"items": { +"$ref": "SubscriberConfig" +}, +"type": "array" +}, +"updateTime": { +"description": "Output only. The time at which the subscriber was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SubscriberConfig": { +"description": "Configuration for a subscriber. A notification is sent to a subscription ONLY if the subscriber has a config for the data type.", +"id": "SubscriberConfig", +"properties": { +"dataTypes": { +"description": "Required. See [Google Health API data types](https://developers.google.com/health/data-types) for the list of supported data types. Values should be in kebab-case.", +"items": { +"type": "string" +}, +"type": "array" +}, +"subscriptionCreatePolicy": { +"description": "Required. Policy for subscription creation.", +"enum": [ +"SUBSCRIPTION_CREATE_POLICY_UNSPECIFIED", +"AUTOMATIC", +"MANUAL" +], +"enumDescriptions": [ +"Represents an unspecified policy.", +"When using `AUTOMATIC`, individual subscriptions are not created or stored. Instead, eligibility for notifications is computed dynamically. When a data update occurs for a given data type, notifications are sent to all subscribers with an `AUTOMATIC` policy for that data type, provided the user has granted the necessary consents. This means you do not need to call `CreateSubscription` for each user; notifications are managed automatically based on user consents. As `Subscription` resources are not stored, they cannot be retrieved or managed through `GetSubscription`, `ListSubscriptions`, `UpdateSubscription`, or `DeleteSubscription`.", +"Requires subscriptions to be created manually for new users. The developer needs to call CreateSubscription for new users." +], +"type": "string" +} +}, +"type": "object" +}, +"Subscription": { +"description": "A subscription to a data collection for a specific user, to be delivered to a subscriber.", +"id": "Subscription", +"properties": { +"dataTypes": { +"description": "Optional. Data types subscribed to. A subscriber will only receive notifications for data types that are declared here. A subscription can only subscribe to the data types of the subscriber. The values should be in the format \"users/{health_user_id}/dataTypes/{data_type}\" where `{data_type}` is one of \"altitude\", \"distance\", \"floors\", \"sleep\", \"steps\", \"weight\".", +"items": { +"type": "string" +}, +"type": "array" +}, +"name": { +"description": "Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise.", +"type": "string" +}, +"user": { +"description": "Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).", +"type": "string" +} +}, +"type": "object" +}, +"SwimLengthsData": { +"description": "Swim lengths data over the time interval.", +"id": "SwimLengthsData", +"properties": { +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +}, +"strokeCount": { +"description": "Required. Number of strokes in the lap.", +"format": "int64", +"type": "string" +}, +"swimStrokeType": { +"description": "Required. Swim stroke type.", +"enum": [ +"SWIM_STROKE_TYPE_UNSPECIFIED", +"FREESTYLE", +"BACKSTROKE", +"BREASTSTROKE", +"BUTTERFLY" +], +"enumDescriptions": [ +"Swim stroke type is unspecified.", +"Freestyle swim stroke type.", +"Backstroke swim stroke type.", +"Breaststroke swim stroke type.", +"Butterfly swim stroke type." +], +"type": "string" +} +}, +"type": "object" +}, +"SwimLengthsDataRollupValue": { +"description": "Represents the result of the rollup of the swim lengths data type.", +"id": "SwimLengthsDataRollupValue", +"properties": { +"strokeCountSum": { +"description": "Total number of swim strokes in the interval.", +"format": "int64", +"type": "string" +} +}, +"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", +"ABDOMINAL_PAIN", +"BLADDER_LEAKS", +"BLEEDING_GUMS", +"BRAIN_FOG", +"BURNING_MOUTH", +"CONSTIPATION", +"CRAVINGS", +"DECREASED_APPETITE", +"DIARRHEA", +"DRAWING_PAIN", +"DRY_EYES", +"DRY_HAIR", +"DRY_SKIN", +"EXHAUSTION", +"FEEL_GOOD", +"FOOD_AVERSIONS", +"HAIR_LOSS", +"HEARTBURN", +"HYPERPIGMENTATION", +"INCREASED_APPETITE", +"INCREASED_APPETITE_V2", +"INSOMNIA", +"JOINT_PAIN", +"LEG_CRAMPS", +"MILKY_NIPPLE_DISCHARGE", +"NAUSEA", +"NIGHT_SWEATS", +"NORMAL_DIGESTION", +"NORMAL_STOOL", +"PERINEUM_PAIN", +"SLEEPINESS", +"STRETCH_MARKS", +"SWELLING", +"VAGINAL_DRYNESS", +"VAGINAL_ITCHING", +"VOMITING" +], +"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.", +"Abdominal pain.", +"Bladder leaks.", +"Bleeding gums.", +"Brain fog.", +"Burning mouth.", +"Constipation.", +"Food cravings.", +"Decreased appetite.", +"Diarrhea.", +"Drawing pain.", +"Dry eyes.", +"Dry hair.", +"Dry skin.", +"Exhaustion.", +"Feeling good or well.", +"Food aversions.", +"Hair loss.", +"Heartburn.", +"Hyperpigmentation.", +"Increased appetite.", +"Increased appetite V2.", +"Insomnia or difficulty sleeping.", +"Joint pain.", +"Leg cramps.", +"Milky nipple discharge.", +"Nausea.", +"Night sweats.", +"Normal digestion.", +"Normal stool.", +"Perineum pain.", +"Sleepiness or drowsiness.", +"Stretch marks.", +"Swelling.", +"Vaginal dryness.", +"Vaginal itching.", +"Vomiting." +], +"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", +"properties": { +"heartRateZoneType": { +"description": "Required. Heart rate zone type.", +"enum": [ +"HEART_RATE_ZONE_TYPE_UNSPECIFIED", +"LIGHT", +"MODERATE", +"VIGOROUS", +"PEAK" +], +"enumDescriptions": [ +"Unspecified heart rate zone.", +"The light heart rate zone.", +"The moderate heart rate zone.", +"The vigorous heart rate zone.", +"The peak heart rate zone." +], +"type": "string" +}, +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval." +} +}, +"type": "object" +}, +"TimeInHeartRateZoneRollupValue": { +"description": "Represents the result of the rollup of the time in heart rate zone data type.", +"id": "TimeInHeartRateZoneRollupValue", +"properties": { +"timeInHeartRateZones": { +"description": "List of time spent in each heart rate zone.", +"items": { +"$ref": "TimeInHeartRateZoneValue" +}, +"type": "array" +} +}, +"type": "object" +}, +"TimeInHeartRateZoneValue": { +"description": "Represents the total time spent in a specific heart rate zone.", +"id": "TimeInHeartRateZoneValue", +"properties": { +"duration": { +"description": "The total time spent in the specified heart rate zone.", +"format": "google-duration", +"type": "string" +}, +"heartRateZone": { +"description": "The heart rate zone.", +"enum": [ +"HEART_RATE_ZONE_TYPE_UNSPECIFIED", +"LIGHT", +"MODERATE", +"VIGOROUS", +"PEAK" +], +"enumDescriptions": [ +"Unspecified heart rate zone.", +"The light heart rate zone.", +"The moderate heart rate zone.", +"The vigorous heart rate zone.", +"The peak heart rate zone." +], +"type": "string" +} +}, +"type": "object" +}, +"TimeInHeartRateZones": { +"description": "Time spent in each heart rate zone.", +"id": "TimeInHeartRateZones", +"properties": { +"lightTime": { +"description": "Optional. Time spent in light heart rate zone.", +"format": "google-duration", +"type": "string" +}, +"moderateTime": { +"description": "Optional. Time spent in moderate heart rate zone.", +"format": "google-duration", +"type": "string" +}, +"peakTime": { +"description": "Optional. Time spent in peak heart rate zone.", +"format": "google-duration", +"type": "string" +}, +"vigorousTime": { +"description": "Optional. Time spent in vigorous heart rate zone.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"TimeOfDay": { +"description": "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`.", +"id": "TimeOfDay", +"properties": { +"hours": { +"description": "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.", +"format": "int32", +"type": "integer" +}, +"minutes": { +"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", +"format": "int32", +"type": "integer" +}, +"nanos": { +"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", +"format": "int32", +"type": "integer" +}, +"seconds": { +"description": "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.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"TimeZone": { +"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", +"id": "TimeZone", +"properties": { +"id": { +"description": "IANA Time Zone Database time zone. For example \"America/New_York\".", +"type": "string" +}, +"version": { +"description": "Optional. IANA Time Zone Database version number. For example \"2019a\".", +"type": "string" +} +}, +"type": "object" +}, +"TotalCaloriesRollupValue": { +"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": { +"description": "Sum of the total calories in kilocalories.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"VO2Max": { +"description": "VO2 max measurement.", +"id": "VO2Max", +"properties": { +"measurementMethod": { +"description": "Optional. The method used to measure the VO2 max value.", +"enum": [ +"MEASUREMENT_METHOD_UNSPECIFIED", +"FITBIT_RUN", +"GOOGLE_DEMOGRAPHIC", +"COOPER_TEST", +"HEART_RATE_RATIO", +"METABOLIC_CART", +"MULTISTAGE_FITNESS_TEST", +"ROCKPORT_FITNESS_TEST", +"MAX_EXERCISE", +"PREDICTION_SUB_MAX_EXERCISE", +"PREDICTION_NON_EXERCISE", +"OTHER" +], +"enumDescriptions": [ +"Unspecified measurement method.", +"Fitbit specific, measures VO2 max rate during a run.", +"Google specific, measures VO2 max rate for a user based on their demographic data.", +"Run as far as possible for 12 minutes. Distance correlated with age and gender translates to a VO2 max value.", +"Maximum heart rate divided by the resting heart rate, with a multiplier applied. Does not require any exercise.", +"Measured by a medical device called metabolic cart.", +"Continuous 20m back-and-forth runs with increasing difficulty, until exhaustion.", +"Measured using walking exercise.", +"Healthkit specific, measures VO2 max rate by monitoring exercise to the user\u2019s physical limit. Similar to COOPER_TEST or MULTISTAGE_FITNESS_TEST.", +"Healthkit specific, estimates VO2 max rate based on low-intensity exercise. Similar to ROCKPORT_FITNESS_TEST.", +"Healthkit specific, estimates VO2 max rate without any exercise. Similar to HEART_RATE_RATIO.", +"Use when the method is not covered in this enum." +], +"type": "string" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which VO2 max was measured." +}, +"vo2Max": { +"description": "Required. VO2 max value measured as in ml consumed oxygen / kg of body weight / min.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"VolumeQuantity": { +"description": "Represents the volume quantity.", +"id": "VolumeQuantity", +"properties": { +"milliliters": { +"description": "Required. Value representing the volume in milliliters.", +"format": "double", +"type": "number" +}, +"userProvidedUnit": { +"description": "Optional. Value representing the user provided unit, used only for user-facing input and display purposes. In the API format, all volume quantities are converted to milliliters.", +"enum": [ +"VOLUME_UNIT_UNSPECIFIED", +"CUP_IMPERIAL", +"CUP_US", +"FLUID_OUNCE_IMPERIAL", +"FLUID_OUNCE_US", +"LITER", +"MILLILITER", +"PINT_IMPERIAL", +"PINT_US" +], +"enumDescriptions": [ +"Unspecified volume unit.", +"Cup (imperial)", +"Cup (US)", +"Fluid ounce (imperial)", +"Fluid ounce (US)", +"Liter", +"Milliliter", +"Pint (imperial)", +"Pint (US)" +], +"type": "string" +} +}, +"type": "object" +}, +"VolumeQuantityRollup": { +"description": "Rollup for volume quantity.", +"id": "VolumeQuantityRollup", +"properties": { +"millilitersSum": { +"description": "Required. The sum of volume in milliliters.", +"format": "double", +"type": "number" +}, +"userProvidedUnitLast": { +"description": "Optional. The user provided unit on the last element.", +"enum": [ +"VOLUME_UNIT_UNSPECIFIED", +"CUP_IMPERIAL", +"CUP_US", +"FLUID_OUNCE_IMPERIAL", +"FLUID_OUNCE_US", +"LITER", +"MILLILITER", +"PINT_IMPERIAL", +"PINT_US" +], +"enumDescriptions": [ +"Unspecified volume unit.", +"Cup (imperial)", +"Cup (US)", +"Fluid ounce (imperial)", +"Fluid ounce (US)", +"Liter", +"Milliliter", +"Pint (imperial)", +"Pint (US)" +], +"type": "string" +} +}, +"type": "object" +}, +"Weight": { +"description": "Body weight measurement.", +"id": "Weight", +"properties": { +"notes": { +"description": "Optional. Standard free-form notes captured at manual logging.", +"type": "string" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which the weight was measured" +}, +"weightGrams": { +"description": "Required. Weight of a user in grams.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"WeightQuantity": { +"description": "Represents the weight quantity.", +"id": "WeightQuantity", +"properties": { +"grams": { +"description": "Required. The weight value in grams.", +"format": "double", +"type": "number" +}, +"userProvidedUnit": { +"description": "Optional. Value representing the user provided unit.", +"enum": [ +"WEIGHT_UNIT_UNSPECIFIED", +"GRAM", +"KILOGRAM", +"OUNCE", +"POUND", +"STONE", +"MILLIGRAM", +"MICROGRAM", +"NANOGRAM" +], +"enumDescriptions": [ +"Unspecified weight unit.", +"Value representing gram.", +"Value representing kilogram.", +"Value representing ounce.", +"Value representing pound.", +"Value representing stone.", +"Value representing milligram.", +"Value representing microgram.", +"Value representing nanogram." +], +"type": "string" +} +}, +"type": "object" +}, +"WeightQuantityRollup": { +"description": "Rollup for the weight.", +"id": "WeightQuantityRollup", +"properties": { +"gramsSum": { +"description": "Required. The sum of the weight in grams.", +"format": "double", +"type": "number" +}, +"userProvidedUnitLast": { +"description": "Optional. The user provided unit on the last element.", +"enum": [ +"WEIGHT_UNIT_UNSPECIFIED", +"GRAM", +"KILOGRAM", +"OUNCE", +"POUND", +"STONE", +"MILLIGRAM", +"MICROGRAM", +"NANOGRAM" +], +"enumDescriptions": [ +"Unspecified weight unit.", +"Value representing gram.", +"Value representing kilogram.", +"Value representing ounce.", +"Value representing pound.", +"Value representing stone.", +"Value representing milligram.", +"Value representing microgram.", +"Value representing nanogram." +], +"type": "string" +} +}, +"type": "object" +}, +"WeightRollupValue": { +"description": "Represents the result of the rollup of the weight data type.", +"id": "WeightRollupValue", +"properties": { +"weightGramsAvg": { +"description": "Average weight in grams.", +"format": "double", +"type": "number" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Google Health API", +"version": "v4beta", +"version_module": true +} \ No newline at end of file From 061939590846fe738730870f23900f7fd3eaf16d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:30 +0000 Subject: [PATCH 20/30] feat(healthcare): update the api #### healthcare:v1 The following keys were added: - schemas.ExportDicomDataRequest.properties.filterConfig.$ref (Total Keys: 1) #### healthcare:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.bulk-export-group-post (Total Keys: 20) --- ...ojects.locations.datasets.dicomStores.html | 3 ++ ...rojects.locations.datasets.fhirStores.html | 45 ++++++++++++++++ .../documents/healthcare.v1.json | 6 ++- .../documents/healthcare.v1beta1.json | 51 ++++++++++++++++++- 4 files changed, 103 insertions(+), 2 deletions(-) diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html index 57d65ec50a..29ad710c05 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html @@ -402,6 +402,9 @@

Method Details

"tableUri": "A String", # Optional. BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` "writeDisposition": "A String", # Optional. Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. }, + "filterConfig": { # Specifies the filter configuration for DICOM resources. # Specifies the filter configuration. + "resourcePathsGcsUri": "A String", # The Cloud Storage location of the filter configuration file. The `gcs_uri` must be in the format `gs://bucket/path/to/object`. The filter configuration file must contain a list of resource paths separated by newline characters (\n or \r\n). Each resource path must be in the format "/studies/{studyUID}[/series/{seriesUID}[/instances/{instanceUID}]]" The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. + }, "gcsDestination": { # The Cloud Storage location where the server writes the output and the export configuration. # The Cloud Storage output destination. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM roles on the Cloud Storage location. "mimeType": "A String", # MIME types supported by DICOM spec. Each file is written in the following format: `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}` The frame_number component exists only for multi-frame instances. Supported MIME types are consistent with supported formats in DICOMweb: https://cloud.google.com/healthcare/docs/dicom#retrieve_transaction. Specifically, the following are supported: - application/dicom; transfer-syntax=1.2.840.10008.1.2 (DICOM Implicit VR Little Endian) - application/dicom; transfer-syntax=1.2.840.10008.1.2.1 (DICOM Explicit VR Little Endian) - application/dicom; transfer-syntax=1.2.840.10008.1.2.1.99 (DICOM Deflated Explicit VR Little Endian) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.50 (DICOM with embedded JPEG Baseline) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.51 (DICOM with embedded JPEG Extended) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.57 (DICOM with embedded JPEG Lossless) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.70 (DICOM with embedded JPEG Lossless First-Order Prediction) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.80 (DICOM with embedded JPEG-LS Lossless) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.81 (DICOM with embedded JPEG-LS Lossy (Near-Lossless)) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.90 (DICOM with embedded JPEG 2000 Lossless Only) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.91 (DICOM with embedded JPEG 2000) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.110 (DICOM with embedded JPEG XL Lossless) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.111 (DICOM with embedded JPEG XL JPEG Recompression) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.112 (DICOM with embedded JPEG XL) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.201 (DICOM with embedded High-Throughput JPEG 2000 Lossless) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.202 (DICOM with embedded High-Throughput JPEG 2000 with RPCL Options Lossless) - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.203 (DICOM with embedded High-Throughput JPEG 2000) - application/dicom; transfer-syntax=1.2.840.10008.1.2.5 (DICOM with embedded RLE Lossless) - application/dicom; transfer-syntax=1.2.840.10008.1.2.8.1 (DICOM with embedded Deflated Image Frame Compression) - application/dicom; transfer-syntax=* (DICOM with no transcoding) - application/octet-stream; transfer-syntax=1.2.840.10008.1.2.1 (raw uncompressed PixelData) - application/octet-stream; transfer-syntax=* (raw PixelData in whatever format it was uploaded in) - image/jpeg; transfer-syntax=1.2.840.10008.1.2.4.50 (Consumer JPEG) - image/png The following extensions are used for output files: - application/dicom -> .dcm - image/jpeg -> .jpg - image/png -> .png - application/octet-stream -> no extension If unspecified, the instances are exported in the original DICOM format they were uploaded in. "uriPrefix": "A String", # The Cloud Storage destination to export to. URI for a Cloud Storage directory where the server writes the result files, in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html index e0bfba9db9..7578a5b407 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html @@ -96,6 +96,9 @@

Instance Methods

bulk_export_group(name, organizeOutputBy=None, outputFormat=None, x__xgafv=None, x_since=None, x_type=None)

Bulk exports a Group resource and resources in the member field, including related resources for each Patient member. The export for each Patient is identical to a GetPatientEverything request. Implements the FHIR implementation guide [$export group of patients](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---group-of-patients). The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only resources of the specified type(s) are exported. * `_since`: if provided, only resources updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. * `organizeOutputBy`: resource type to organize the output by. Required and must be set to `Patient`. When specified, output files are organized by instances of the specified resource type, including the resource, referenced resources, and resources that contain references to that resource. On success, the `Content-Location` header of response is set to a URL that you can use to query the status of the export. The URL is in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.

+

+ bulk_export_group_post(name, body=None, organizeOutputBy=None, outputFormat=None, x__xgafv=None, x_since=None, x_type=None)

+

Export resources using POST.

close()

Close httplib2 connections.

@@ -332,6 +335,48 @@

Method Details

}
+
+ bulk_export_group_post(name, body=None, organizeOutputBy=None, outputFormat=None, x__xgafv=None, x_since=None, x_type=None) +
Export resources using POST.
+
+Args:
+  name: string, Required. Name of the `Group` resource that is exported, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. (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.
+    },
+  ],
+}
+
+  organizeOutputBy: string, Required. The FHIR resource type used to organize exported resources. Only supports "Patient". When organized by Patient resource, output files are grouped as follows: * Patient file(s) containing the Patient resources. Each Patient is sequentially followed by all resources the Patient references, and all resources that reference the Patient (equivalent to a GetPatientEverything request). * Individual files grouped by resource type for resources in the Group's member field and the Group resource itself. Resources may be duplicated across multiple Patients. For example, if two Patient resources reference the same Organization resource, it will appear twice, once after each Patient. The Group resource from the request does not appear in the Patient files.
+  outputFormat: string, Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+  x_since: string, Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.
+  x_type: string, Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json index e2acfed8fb..d9e8f8266b 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json @@ -5171,7 +5171,7 @@ } } }, -"revision": "20260806", +"revision": "20260908", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -6638,6 +6638,10 @@ "$ref": "GoogleCloudHealthcareV1DicomBigQueryDestination", "description": "The BigQuery output destination. You can only export to a BigQuery dataset that's in the same project as the DICOM store you're exporting from. The Cloud Healthcare Service Agent requires two IAM roles on the BigQuery location: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`." }, +"filterConfig": { +"$ref": "DicomFilterConfig", +"description": "Specifies the filter configuration." +}, "gcsDestination": { "$ref": "GoogleCloudHealthcareV1DicomGcsDestination", "description": "The Cloud Storage output destination. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM roles on the Cloud Storage location." diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index ad186af3e7..5951113360 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -3285,6 +3285,55 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"bulk-export-group-post": { +"description": "Export resources using POST.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Group/{GroupId}/$export", +"httpMethod": "POST", +"id": "healthcare.projects.locations.datasets.fhirStores.bulk-export-group-post", +"parameterOrder": [ +"name" +], +"parameters": { +"_since": { +"description": "Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.", +"location": "query", +"type": "string" +}, +"_type": { +"description": "Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. Name of the `Group` resource that is exported, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Group/[^/]+$", +"required": true, +"type": "string" +}, +"organizeOutputBy": { +"description": "Required. The FHIR resource type used to organize exported resources. Only supports \"Patient\". When organized by Patient resource, output files are grouped as follows: * Patient file(s) containing the Patient resources. Each Patient is sequentially followed by all resources the Patient references, and all resources that reference the Patient (equivalent to a GetPatientEverything request). * Individual files grouped by resource type for resources in the Group's member field and the Group resource itself. Resources may be duplicated across multiple Patients. For example, if two Patient resources reference the same Organization resource, it will appear twice, once after each Patient. The Group resource from the request does not appear in the Patient files.", +"location": "query", +"type": "string" +}, +"outputFormat": { +"description": "Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}/$export", +"request": { +"$ref": "HttpBody" +}, +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "bulkDelete": { "description": "Bulk deletes the FHIR resources from the given FHIR store. This method returns an Operation that can be used to track the progress of the deletion by calling GetOperation. The success and secondary_success counters correspond to the deleted current version and historical versions, respectively.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:bulkDelete", @@ -5718,7 +5767,7 @@ } } }, -"revision": "20260806", +"revision": "20260908", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { From 257d6bd428123245c6e1c88c9c623eb0a6802962 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:30 +0000 Subject: [PATCH 21/30] feat(managedkafka): update the api #### managedkafka:v1 The following keys were deleted: - schemas.Cluster.properties.kafkaVersion.readOnly (Total Keys: 1) --- docs/dyn/managedkafka_v1.projects.locations.clusters.html | 8 ++++---- .../discovery_cache/documents/managedkafka.v1.json | 5 ++--- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/dyn/managedkafka_v1.projects.locations.clusters.html b/docs/dyn/managedkafka_v1.projects.locations.clusters.html index 50042051b3..f242cd8dad 100644 --- a/docs/dyn/managedkafka_v1.projects.locations.clusters.html +++ b/docs/dyn/managedkafka_v1.projects.locations.clusters.html @@ -161,7 +161,7 @@

Method Details

}, "kmsKey": "A String", # Optional. Immutable. The Cloud KMS Key name to use for encryption. The key must be located in the same region as the cluster and cannot be changed. Structured like: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. }, - "kafkaVersion": "A String", # Output only. Only populated when FULL view is requested. The Kafka version of the cluster. + "kafkaVersion": "A String", # Optional. The Apache Kafka version of the cluster (for example, `3.7.x`, `4.3.x`). If not specified during cluster creation, defaults to `3.7.x`. "labels": { # Optional. Labels as key value pairs. "a_key": "A String", }, @@ -318,7 +318,7 @@

Method Details

}, "kmsKey": "A String", # Optional. Immutable. The Cloud KMS Key name to use for encryption. The key must be located in the same region as the cluster and cannot be changed. Structured like: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. }, - "kafkaVersion": "A String", # Output only. Only populated when FULL view is requested. The Kafka version of the cluster. + "kafkaVersion": "A String", # Optional. The Apache Kafka version of the cluster (for example, `3.7.x`, `4.3.x`). If not specified during cluster creation, defaults to `3.7.x`. "labels": { # Optional. Labels as key value pairs. "a_key": "A String", }, @@ -410,7 +410,7 @@

Method Details

}, "kmsKey": "A String", # Optional. Immutable. The Cloud KMS Key name to use for encryption. The key must be located in the same region as the cluster and cannot be changed. Structured like: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. }, - "kafkaVersion": "A String", # Output only. Only populated when FULL view is requested. The Kafka version of the cluster. + "kafkaVersion": "A String", # Optional. The Apache Kafka version of the cluster (for example, `3.7.x`, `4.3.x`). If not specified during cluster creation, defaults to `3.7.x`. "labels": { # Optional. Labels as key value pairs. "a_key": "A String", }, @@ -511,7 +511,7 @@

Method Details

}, "kmsKey": "A String", # Optional. Immutable. The Cloud KMS Key name to use for encryption. The key must be located in the same region as the cluster and cannot be changed. Structured like: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. }, - "kafkaVersion": "A String", # Output only. Only populated when FULL view is requested. The Kafka version of the cluster. + "kafkaVersion": "A String", # Optional. The Apache Kafka version of the cluster (for example, `3.7.x`, `4.3.x`). If not specified during cluster creation, defaults to `3.7.x`. "labels": { # Optional. Labels as key value pairs. "a_key": "A String", }, diff --git a/googleapiclient/discovery_cache/documents/managedkafka.v1.json b/googleapiclient/discovery_cache/documents/managedkafka.v1.json index 1d7f67063e..efef1da2bf 100644 --- a/googleapiclient/discovery_cache/documents/managedkafka.v1.json +++ b/googleapiclient/discovery_cache/documents/managedkafka.v1.json @@ -3186,7 +3186,7 @@ } } }, -"revision": "20260827", +"revision": "20260904", "rootUrl": "https://managedkafka.googleapis.com/", "schemas": { "AccessConfig": { @@ -3449,8 +3449,7 @@ "description": "Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform." }, "kafkaVersion": { -"description": "Output only. Only populated when FULL view is requested. The Kafka version of the cluster.", -"readOnly": true, +"description": "Optional. The Apache Kafka version of the cluster (for example, `3.7.x`, `4.3.x`). If not specified during cluster creation, defaults to `3.7.x`.", "type": "string" }, "labels": { From 5696ab13a29ab010856fb65860d5d5fe33d501cc Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:30 +0000 Subject: [PATCH 22/30] feat(merchantapi): update the api #### merchantapi:products_v1 The following keys were added: - schemas.ProductInstallment.properties.mileageAllowance.$ref (Total Keys: 1) --- ...ntapi_products_v1.accounts.productInputs.html | 16 ++++++++++++++++ ...erchantapi_products_v1.accounts.products.html | 8 ++++++++ .../documents/merchantapi.products_v1.json | 6 +++++- 3 files changed, 29 insertions(+), 1 deletion(-) diff --git a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html index cf2fac74a7..961443f9aa 100644 --- a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html +++ b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html @@ -310,6 +310,10 @@

Method Details

"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). }, + "mileageAllowance": { # The mileage of the vehicle. # Optional. The mileage allowance for the lease of the vehicle. Only applicable to vehicle products. + "unit": "A String", # The unit of the mileage. + "value": "A String", # The distance value. + }, "months": "A String", # The number of installments the buyer has to pay. "totalAmount": { # The price represented as a number and currency. # Optional. Total amount the buyer has to pay, including interest. "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). @@ -850,6 +854,10 @@

Method Details

"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). }, + "mileageAllowance": { # The mileage of the vehicle. # Optional. The mileage allowance for the lease of the vehicle. Only applicable to vehicle products. + "unit": "A String", # The unit of the mileage. + "value": "A String", # The distance value. + }, "months": "A String", # The number of installments the buyer has to pay. "totalAmount": { # The price represented as a number and currency. # Optional. Total amount the buyer has to pay, including interest. "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). @@ -1391,6 +1399,10 @@

Method Details

"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). }, + "mileageAllowance": { # The mileage of the vehicle. # Optional. The mileage allowance for the lease of the vehicle. Only applicable to vehicle products. + "unit": "A String", # The unit of the mileage. + "value": "A String", # The distance value. + }, "months": "A String", # The number of installments the buyer has to pay. "totalAmount": { # The price represented as a number and currency. # Optional. Total amount the buyer has to pay, including interest. "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). @@ -1932,6 +1944,10 @@

Method Details

"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). }, + "mileageAllowance": { # The mileage of the vehicle. # Optional. The mileage allowance for the lease of the vehicle. Only applicable to vehicle products. + "unit": "A String", # The unit of the mileage. + "value": "A String", # The distance value. + }, "months": "A String", # The number of installments the buyer has to pay. "totalAmount": { # The price represented as a number and currency. # Optional. Total amount the buyer has to pay, including interest. "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). diff --git a/docs/dyn/merchantapi_products_v1.accounts.products.html b/docs/dyn/merchantapi_products_v1.accounts.products.html index 9d23b00fc6..9c277c9c90 100644 --- a/docs/dyn/merchantapi_products_v1.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1.accounts.products.html @@ -310,6 +310,10 @@

Method Details

"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). }, + "mileageAllowance": { # The mileage of the vehicle. # Optional. The mileage allowance for the lease of the vehicle. Only applicable to vehicle products. + "unit": "A String", # The unit of the mileage. + "value": "A String", # The distance value. + }, "months": "A String", # The number of installments the buyer has to pay. "totalAmount": { # The price represented as a number and currency. # Optional. Total amount the buyer has to pay, including interest. "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). @@ -909,6 +913,10 @@

Method Details

"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). }, + "mileageAllowance": { # The mileage of the vehicle. # Optional. The mileage allowance for the lease of the vehicle. Only applicable to vehicle products. + "unit": "A String", # The unit of the mileage. + "value": "A String", # The distance value. + }, "months": "A String", # The number of installments the buyer has to pay. "totalAmount": { # The price represented as a number and currency. # Optional. Total amount the buyer has to pay, including interest. "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). diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json index e783b230ac..6bfeed7466 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json @@ -281,7 +281,7 @@ } } }, -"revision": "20260903", +"revision": "20260910", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AutomatedDiscounts": { @@ -2885,6 +2885,10 @@ false "$ref": "Price", "description": "The up-front down payment amount the buyer has to pay." }, +"mileageAllowance": { +"$ref": "Mileage", +"description": "Optional. The mileage allowance for the lease of the vehicle. Only applicable to vehicle products." +}, "months": { "description": "The number of installments the buyer has to pay.", "format": "int64", From c8071e0e37124a903a4ff9a9775dff3bb3b7a673 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:30 +0000 Subject: [PATCH 23/30] feat(monitoring): update the api #### monitoring:v1 The following keys were added: - schemas.TimeRange (Total Keys: 5) - schemas.Widget.properties.timeRange.$ref (Total Keys: 1) --- .../monitoring_v1.projects.dashboards.html | 168 ++++++++++++++++++ .../documents/monitoring.v1.json | 22 ++- 2 files changed, 189 insertions(+), 1 deletion(-) diff --git a/docs/dyn/monitoring_v1.projects.dashboards.html b/docs/dyn/monitoring_v1.projects.dashboards.html index 002cb958a4..6cb436a345 100644 --- a/docs/dyn/monitoring_v1.projects.dashboards.html +++ b/docs/dyn/monitoring_v1.projects.dashboards.html @@ -546,6 +546,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -1649,6 +1656,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -2610,6 +2624,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -3573,6 +3594,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -4561,6 +4589,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -5664,6 +5699,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -6625,6 +6667,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -7588,6 +7637,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -8600,6 +8656,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -9703,6 +9766,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -10664,6 +10734,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -11627,6 +11704,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -12625,6 +12709,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -13728,6 +13819,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -14689,6 +14787,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -15652,6 +15757,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -16658,6 +16770,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -17761,6 +17880,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -18722,6 +18848,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -19685,6 +19818,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -20673,6 +20813,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -21776,6 +21923,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -22737,6 +22891,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. @@ -23700,6 +23861,13 @@

Method Details

"verticalAlignment": "A String", # The vertical alignment of both the title and content }, }, + "timeRange": { # Represents a time range. # Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only. + "absoluteWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive. + "endTime": "A String", # Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "relativeDuration": "A String", # Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive. + }, "timeSeriesTable": { # A table that displays time series data. # A widget that displays time series data in a tabular format. "columnSettings": [ # Optional. The list of the persistent column settings for the table. { # The persistent settings for a table's columns. diff --git a/googleapiclient/discovery_cache/documents/monitoring.v1.json b/googleapiclient/discovery_cache/documents/monitoring.v1.json index 3e69bf19ac..79af97e096 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v1.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json @@ -753,7 +753,7 @@ } } }, -"revision": "20260705", +"revision": "20260903", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -2866,6 +2866,22 @@ }, "type": "object" }, +"TimeRange": { +"description": "Represents a time range.", +"id": "TimeRange", +"properties": { +"absoluteWindow": { +"$ref": "Interval", +"description": "Optional. Represents a time range with absolute start and end times. The start time is inclusive, and the end time is exclusive." +}, +"relativeDuration": { +"description": "Optional. Specifies the duration used to shift the data relative to current time as the end time. The duration must be positive.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, "TimeSeriesFilter": { "description": "A filter that defines a subset of time series data that is displayed in a widget. Time series data is fetched using the ListTimeSeries (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) method.", "id": "TimeSeriesFilter", @@ -3194,6 +3210,10 @@ "$ref": "Text", "description": "A raw string or markdown displaying textual content." }, +"timeRange": { +"$ref": "TimeRange", +"description": "Optional. Represents a time range for the widget. When set, this time range will override the dashboard time range. Supported for line, stacked area and stacked bar widgets only." +}, "timeSeriesTable": { "$ref": "TimeSeriesTable", "description": "A widget that displays time series data in a tabular format." From 8e2b06f51c90be2bcca9f144852a26e41900015b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:30 +0000 Subject: [PATCH 24/30] feat(networkconnectivity): update the api #### networkconnectivity:v1 The following keys were added: - schemas.Transport.properties.autoAccept.type (Total Keys: 1) - schemas.Transport.properties.hub.type (Total Keys: 1) - schemas.Transport.properties.pscRoutingEnabled.type (Total Keys: 1) --- ...nectivity_v1.projects.locations.transports.html | 12 ++++++++++++ .../documents/networkconnectivity.v1.json | 14 +++++++++++++- 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.transports.html b/docs/dyn/networkconnectivity_v1.projects.locations.transports.html index e7eef9d7e5..27c0f8eec1 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.transports.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.transports.html @@ -114,10 +114,12 @@

Method Details

"advertisedRoutes": [ # Optional. List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported. "A String", ], + "autoAccept": True or False, # Optional. Immutable. Controls whether resources proposed by the Transport are automatically accepted on behalf of the user. List of actions that can be automatically accepted are: 1. VPC Peering creation 2. Routing VPC Spoke creation 3. Hybrid Spoke creation "bandwidth": "A String", # Optional. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile, and must be set when no activation key is being provided. "createTime": "A String", # Output only. Create time stamp. "description": "A String", # Optional. Description of the Transport. "generatedActivationKey": "A String", # Output only. Google-generated activation key. This is only output if the selected profile supports an OUTPUT key flow. Inputting this to the provider is only valid while the resource is in a PENDING_KEY state. Once the provider has accepted the key, the resource will move to the CONFIGURING state. + "hub": "A String", # Optional. Immutable. The NCC Hub that the Transport should attach to. The hub must be in the same project as the Transport. Format: `{hub}` or `projects/{project}/locations/global/hubs/{hub}` "labels": { # Optional. Labels as key value pairs. "a_key": "A String", }, @@ -126,6 +128,7 @@

Method Details

"network": "A String", # Optional. Immutable. Resource URI of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed. "peeringNetwork": "A String", # Output only. VPC Network URI that was created for the VPC Peering connection to the provided `network`. If VPC Peering is disconnected, this can be used to re-establish. "providedActivationKey": "A String", # Optional. Immutable. Key used for establishing a connection with the remote transport. This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state. + "pscRoutingEnabled": True or False, # Optional. Immutable. Controls whether a Routing VPC Spoke should be created and attached to the NCC Hub. This will provide Private Service Connect (PSC) connectivity through NCC. This can only be set when the Transport is first created. "remoteAccountId": "A String", # Optional. Immutable. The user supplied account id for the CSP associated with the remote profile. "remoteProfile": "A String", # Optional. Immutable. Name of the remoteTransportProfile that this Transport is connecting to. "stackType": "A String", # Optional. IP version stack for the established connectivity. @@ -218,10 +221,12 @@

Method Details

"advertisedRoutes": [ # Optional. List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported. "A String", ], + "autoAccept": True or False, # Optional. Immutable. Controls whether resources proposed by the Transport are automatically accepted on behalf of the user. List of actions that can be automatically accepted are: 1. VPC Peering creation 2. Routing VPC Spoke creation 3. Hybrid Spoke creation "bandwidth": "A String", # Optional. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile, and must be set when no activation key is being provided. "createTime": "A String", # Output only. Create time stamp. "description": "A String", # Optional. Description of the Transport. "generatedActivationKey": "A String", # Output only. Google-generated activation key. This is only output if the selected profile supports an OUTPUT key flow. Inputting this to the provider is only valid while the resource is in a PENDING_KEY state. Once the provider has accepted the key, the resource will move to the CONFIGURING state. + "hub": "A String", # Optional. Immutable. The NCC Hub that the Transport should attach to. The hub must be in the same project as the Transport. Format: `{hub}` or `projects/{project}/locations/global/hubs/{hub}` "labels": { # Optional. Labels as key value pairs. "a_key": "A String", }, @@ -230,6 +235,7 @@

Method Details

"network": "A String", # Optional. Immutable. Resource URI of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed. "peeringNetwork": "A String", # Output only. VPC Network URI that was created for the VPC Peering connection to the provided `network`. If VPC Peering is disconnected, this can be used to re-establish. "providedActivationKey": "A String", # Optional. Immutable. Key used for establishing a connection with the remote transport. This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state. + "pscRoutingEnabled": True or False, # Optional. Immutable. Controls whether a Routing VPC Spoke should be created and attached to the NCC Hub. This will provide Private Service Connect (PSC) connectivity through NCC. This can only be set when the Transport is first created. "remoteAccountId": "A String", # Optional. Immutable. The user supplied account id for the CSP associated with the remote profile. "remoteProfile": "A String", # Optional. Immutable. Name of the remoteTransportProfile that this Transport is connecting to. "stackType": "A String", # Optional. IP version stack for the established connectivity. @@ -263,10 +269,12 @@

Method Details

"advertisedRoutes": [ # Optional. List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported. "A String", ], + "autoAccept": True or False, # Optional. Immutable. Controls whether resources proposed by the Transport are automatically accepted on behalf of the user. List of actions that can be automatically accepted are: 1. VPC Peering creation 2. Routing VPC Spoke creation 3. Hybrid Spoke creation "bandwidth": "A String", # Optional. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile, and must be set when no activation key is being provided. "createTime": "A String", # Output only. Create time stamp. "description": "A String", # Optional. Description of the Transport. "generatedActivationKey": "A String", # Output only. Google-generated activation key. This is only output if the selected profile supports an OUTPUT key flow. Inputting this to the provider is only valid while the resource is in a PENDING_KEY state. Once the provider has accepted the key, the resource will move to the CONFIGURING state. + "hub": "A String", # Optional. Immutable. The NCC Hub that the Transport should attach to. The hub must be in the same project as the Transport. Format: `{hub}` or `projects/{project}/locations/global/hubs/{hub}` "labels": { # Optional. Labels as key value pairs. "a_key": "A String", }, @@ -275,6 +283,7 @@

Method Details

"network": "A String", # Optional. Immutable. Resource URI of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed. "peeringNetwork": "A String", # Output only. VPC Network URI that was created for the VPC Peering connection to the provided `network`. If VPC Peering is disconnected, this can be used to re-establish. "providedActivationKey": "A String", # Optional. Immutable. Key used for establishing a connection with the remote transport. This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state. + "pscRoutingEnabled": True or False, # Optional. Immutable. Controls whether a Routing VPC Spoke should be created and attached to the NCC Hub. This will provide Private Service Connect (PSC) connectivity through NCC. This can only be set when the Transport is first created. "remoteAccountId": "A String", # Optional. Immutable. The user supplied account id for the CSP associated with the remote profile. "remoteProfile": "A String", # Optional. Immutable. Name of the remoteTransportProfile that this Transport is connecting to. "stackType": "A String", # Optional. IP version stack for the established connectivity. @@ -315,10 +324,12 @@

Method Details

"advertisedRoutes": [ # Optional. List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported. "A String", ], + "autoAccept": True or False, # Optional. Immutable. Controls whether resources proposed by the Transport are automatically accepted on behalf of the user. List of actions that can be automatically accepted are: 1. VPC Peering creation 2. Routing VPC Spoke creation 3. Hybrid Spoke creation "bandwidth": "A String", # Optional. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile, and must be set when no activation key is being provided. "createTime": "A String", # Output only. Create time stamp. "description": "A String", # Optional. Description of the Transport. "generatedActivationKey": "A String", # Output only. Google-generated activation key. This is only output if the selected profile supports an OUTPUT key flow. Inputting this to the provider is only valid while the resource is in a PENDING_KEY state. Once the provider has accepted the key, the resource will move to the CONFIGURING state. + "hub": "A String", # Optional. Immutable. The NCC Hub that the Transport should attach to. The hub must be in the same project as the Transport. Format: `{hub}` or `projects/{project}/locations/global/hubs/{hub}` "labels": { # Optional. Labels as key value pairs. "a_key": "A String", }, @@ -327,6 +338,7 @@

Method Details

"network": "A String", # Optional. Immutable. Resource URI of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed. "peeringNetwork": "A String", # Output only. VPC Network URI that was created for the VPC Peering connection to the provided `network`. If VPC Peering is disconnected, this can be used to re-establish. "providedActivationKey": "A String", # Optional. Immutable. Key used for establishing a connection with the remote transport. This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state. + "pscRoutingEnabled": True or False, # Optional. Immutable. Controls whether a Routing VPC Spoke should be created and attached to the NCC Hub. This will provide Private Service Connect (PSC) connectivity through NCC. This can only be set when the Transport is first created. "remoteAccountId": "A String", # Optional. Immutable. The user supplied account id for the CSP associated with the remote profile. "remoteProfile": "A String", # Optional. Immutable. Name of the remoteTransportProfile that this Transport is connecting to. "stackType": "A String", # Optional. IP version stack for the established connectivity. diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json index 9eae29615d..46604be68f 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json @@ -4046,7 +4046,7 @@ } } }, -"revision": "20260715", +"revision": "20260908", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -8180,6 +8180,10 @@ }, "type": "array" }, +"autoAccept": { +"description": "Optional. Immutable. Controls whether resources proposed by the Transport are automatically accepted on behalf of the user. List of actions that can be automatically accepted are: 1. VPC Peering creation 2. Routing VPC Spoke creation 3. Hybrid Spoke creation", +"type": "boolean" +}, "bandwidth": { "description": "Optional. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile, and must be set when no activation key is being provided.", "enum": [ @@ -8231,6 +8235,10 @@ "readOnly": true, "type": "string" }, +"hub": { +"description": "Optional. Immutable. The NCC Hub that the Transport should attach to. The hub must be in the same project as the Transport. Format: `{hub}` or `projects/{project}/locations/global/hubs/{hub}`", +"type": "string" +}, "labels": { "additionalProperties": { "type": "string" @@ -8261,6 +8269,10 @@ "description": "Optional. Immutable. Key used for establishing a connection with the remote transport. This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state.", "type": "string" }, +"pscRoutingEnabled": { +"description": "Optional. Immutable. Controls whether a Routing VPC Spoke should be created and attached to the NCC Hub. This will provide Private Service Connect (PSC) connectivity through NCC. This can only be set when the Transport is first created.", +"type": "boolean" +}, "remoteAccountId": { "description": "Optional. Immutable. The user supplied account id for the CSP associated with the remote profile.", "type": "string" From 1d1ebb07bfcd830a6be623b1dcd763e369519398 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:30 +0000 Subject: [PATCH 25/30] feat(networkservices): update the api #### networkservices:v1 The following keys were added: - resources.projects.resources.locations.resources.agentGateways.methods.list.parameters.filter (Total Keys: 2) #### networkservices:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.agentGateways.methods.list.parameters.filter (Total Keys: 2) --- ...etworkservices_v1.projects.locations.agentGateways.html | 5 +++-- ...kservices_v1beta1.projects.locations.agentGateways.html | 5 +++-- .../discovery_cache/documents/networkservices.v1.json | 7 ++++++- .../discovery_cache/documents/networkservices.v1beta1.json | 7 ++++++- 4 files changed, 18 insertions(+), 6 deletions(-) diff --git a/docs/dyn/networkservices_v1.projects.locations.agentGateways.html b/docs/dyn/networkservices_v1.projects.locations.agentGateways.html index e37500b1f0..8de5eb48a5 100644 --- a/docs/dyn/networkservices_v1.projects.locations.agentGateways.html +++ b/docs/dyn/networkservices_v1.projects.locations.agentGateways.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single AgentGateway.

- list(parent, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

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

Lists AgentGateways in a given project and location.

list_next(previous_request, previous_response)

@@ -284,11 +284,12 @@

Method Details

- list(parent, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + list(parent, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists AgentGateways in a given project and location.
 
 Args:
   parent: string, Required. The project and location from which the AgentGateways should be listed, specified in the format `projects/*/locations/*`. (required)
+  filter: string, Optional. A filter expression to filter the results listed in the response. The expression must follow the syntax described in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, Optional. Maximum number of AgentGateways to return per call.
   pageToken: string, Optional. The value returned by the last `ListAgentGatewaysResponse` Indicates that this is a continuation of a prior `ListAgentGateways` 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.
diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.agentGateways.html b/docs/dyn/networkservices_v1beta1.projects.locations.agentGateways.html
index 0f9d9a48f9..ccc27451b9 100644
--- a/docs/dyn/networkservices_v1beta1.projects.locations.agentGateways.html
+++ b/docs/dyn/networkservices_v1beta1.projects.locations.agentGateways.html
@@ -87,7 +87,7 @@ 

Instance Methods

get(name, x__xgafv=None)

Gets details of a single AgentGateway.

- list(parent, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

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

Lists AgentGateways in a given project and location.

list_next(previous_request, previous_response)

@@ -284,11 +284,12 @@

Method Details

- list(parent, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + list(parent, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists AgentGateways in a given project and location.
 
 Args:
   parent: string, Required. The project and location from which the AgentGateways should be listed, specified in the format `projects/*/locations/*`. (required)
+  filter: string, Optional. A filter expression to filter the results listed in the response. The expression must follow the syntax described in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, Optional. Maximum number of AgentGateways to return per call.
   pageToken: string, Optional. The value returned by the last `ListAgentGatewaysResponse` Indicates that this is a continuation of a prior `ListAgentGateways` 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.
diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json
index e765d93540..1f21b81d0f 100644
--- a/googleapiclient/discovery_cache/documents/networkservices.v1.json
+++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json
@@ -449,6 +449,11 @@
 "parent"
 ],
 "parameters": {
+"filter": {
+"description": "Optional. A filter expression to filter the results listed in the response. The expression must follow the syntax described in [AIP-160](https://google.aip.dev/160).",
+"location": "query",
+"type": "string"
+},
 "pageSize": {
 "description": "Optional. Maximum number of AgentGateways to return per call.",
 "format": "int32",
@@ -4189,7 +4194,7 @@
 }
 }
 },
-"revision": "20260816",
+"revision": "20260901",
 "rootUrl": "https://networkservices.googleapis.com/",
 "schemas": {
 "AgentConnectivityTemplate": {
diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json
index 198579e3b1..cb229e6c1e 100644
--- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json
@@ -449,6 +449,11 @@
 "parent"
 ],
 "parameters": {
+"filter": {
+"description": "Optional. A filter expression to filter the results listed in the response. The expression must follow the syntax described in [AIP-160](https://google.aip.dev/160).",
+"location": "query",
+"type": "string"
+},
 "pageSize": {
 "description": "Optional. Maximum number of AgentGateways to return per call.",
 "format": "int32",
@@ -3916,7 +3921,7 @@
 }
 }
 },
-"revision": "20260821",
+"revision": "20260901",
 "rootUrl": "https://networkservices.googleapis.com/",
 "schemas": {
 "AgentConnectivityTemplate": {

From 4f5713fa1f43b54d7b7c6441672d489b3a3b39ba Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 15 Sep 2026 07:22:30 +0000
Subject: [PATCH 26/30] feat(playintegrity): update the api

#### playintegrity:v1

The following keys were added:
- schemas.EnvironmentDetails.properties.locationSpoofingRiskVerdict (Total Keys: 2)
---
 docs/dyn/playintegrity_v1.v1.html             |  3 +++
 .../documents/playintegrity.v1.json           | 27 ++++++++++++++++++-
 2 files changed, 29 insertions(+), 1 deletion(-)

diff --git a/docs/dyn/playintegrity_v1.v1.html b/docs/dyn/playintegrity_v1.v1.html
index 3aa9d5a6c9..1a155ef6c4 100644
--- a/docs/dyn/playintegrity_v1.v1.html
+++ b/docs/dyn/playintegrity_v1.v1.html
@@ -158,6 +158,9 @@ 

Method Details

"A String", ], }, + "locationSpoofingRiskVerdict": [ # The evaluation of the Location Spoofing Risk verdict. + "A String", + ], "playProtectVerdict": "A String", # The evaluation of Play Protect verdict. }, "requestDetails": { # Contains the integrity request information. # Required. Details about the integrity request. diff --git a/googleapiclient/discovery_cache/documents/playintegrity.v1.json b/googleapiclient/discovery_cache/documents/playintegrity.v1.json index a4fa77888f..b4131b9ed2 100644 --- a/googleapiclient/discovery_cache/documents/playintegrity.v1.json +++ b/googleapiclient/discovery_cache/documents/playintegrity.v1.json @@ -198,7 +198,7 @@ } } }, -"revision": "20250828", +"revision": "20260910", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountActivity": { @@ -472,6 +472,31 @@ "$ref": "AppAccessRiskVerdict", "description": "The evaluation of the App Access Risk verdicts." }, +"locationSpoofingRiskVerdict": { +"description": "The evaluation of the Location Spoofing Risk verdict.", +"items": { +"enum": [ +"LOCATION_SPOOFING_RISK_VERDICT_UNSPECIFIED", +"LOW_RISK_DEVICE", +"LOW_RISK_NETWORK", +"MEDIUM_RISK_DEVICE", +"MEDIUM_RISK_NETWORK", +"HIGH_RISK_DEVICE", +"HIGH_RISK_NETWORK" +], +"enumDescriptions": [ +"Catch-all for unrecognized enum values.", +"Device-related spoofing was evaluated, and no issues were detected.", +"Network-related spoofing was evaluated, and no issues were detected.", +"Potential device-related spoofing was detected.", +"Potential network-related spoofing was detected.", +"Likely device-related spoofing was detected.", +"Likely network-related spoofing was detected." +], +"type": "string" +}, +"type": "array" +}, "playProtectVerdict": { "description": "The evaluation of Play Protect verdict.", "enum": [ From bea56ca27cf3698515dd0a1e300d596cf612b02b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:30 +0000 Subject: [PATCH 27/30] feat(run): update the api #### run:v2 The following keys were added: - schemas.GoogleCloudRunV2Instance.properties.sshEnabled.type (Total Keys: 1) - schemas.GoogleCloudRunV2Job.properties.functionalType.type (Total Keys: 1) - schemas.GoogleCloudRunV2Service.properties.functionalType.type (Total Keys: 1) - schemas.GoogleCloudRunV2Task.properties.workloadIdentityConfig.$ref (Total Keys: 1) - schemas.GoogleCloudRunV2TaskTemplate.properties.workloadIdentityConfig.$ref (Total Keys: 1) - schemas.GoogleCloudRunV2WorkloadIdentityConfig (Total Keys: 5) --- .../dyn/run_v1.namespaces.configurations.html | 8 +- .../dyn/run_v1.namespaces.domainmappings.html | 8 +- docs/dyn/run_v1.namespaces.executions.html | 6 +- docs/dyn/run_v1.namespaces.instances.html | 16 ++-- docs/dyn/run_v1.namespaces.jobs.html | 26 +++--- docs/dyn/run_v1.namespaces.revisions.html | 4 +- docs/dyn/run_v1.namespaces.routes.html | 4 +- docs/dyn/run_v1.namespaces.services.html | 24 +++--- docs/dyn/run_v1.namespaces.tasks.html | 4 +- docs/dyn/run_v1.namespaces.workerpools.html | 24 +++--- ..._v1.projects.locations.configurations.html | 8 +- ..._v1.projects.locations.domainmappings.html | 8 +- .../run_v1.projects.locations.revisions.html | 4 +- .../dyn/run_v1.projects.locations.routes.html | 4 +- .../run_v1.projects.locations.services.html | 24 +++--- .../run_v2.projects.locations.instances.html | 4 + ...v2.projects.locations.jobs.executions.html | 10 +++ ...jects.locations.jobs.executions.tasks.html | 10 +++ docs/dyn/run_v2.projects.locations.jobs.html | 24 ++++++ .../run_v2.projects.locations.services.html | 24 ++++++ ...projects.locations.services.revisions.html | 10 +++ ...jects.locations.workerPools.revisions.html | 10 +++ .../discovery_cache/documents/run.v1.json | 4 +- .../discovery_cache/documents/run.v2.json | 79 ++++++++++++++++++- 24 files changed, 258 insertions(+), 89 deletions(-) diff --git a/docs/dyn/run_v1.namespaces.configurations.html b/docs/dyn/run_v1.namespaces.configurations.html index 0f2d46f862..e3f4ce36c3 100644 --- a/docs/dyn/run_v1.namespaces.configurations.html +++ b/docs/dyn/run_v1.namespaces.configurations.html @@ -107,7 +107,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of resource, in this case always "Configuration". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Configuration, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -141,7 +141,7 @@

Method Details

"spec": { # ConfigurationSpec holds the desired state of the Configuration (from the client). # Spec holds the desired state of the Configuration (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Template holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -462,7 +462,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of resource, in this case always "Configuration". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Configuration, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -496,7 +496,7 @@

Method Details

"spec": { # ConfigurationSpec holds the desired state of the Configuration (from the client). # Spec holds the desired state of the Configuration (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Template holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.domainmappings.html b/docs/dyn/run_v1.namespaces.domainmappings.html index 9318df16c9..159a367f59 100644 --- a/docs/dyn/run_v1.namespaces.domainmappings.html +++ b/docs/dyn/run_v1.namespaces.domainmappings.html @@ -108,7 +108,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -181,7 +181,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -305,7 +305,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -394,7 +394,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.executions.html b/docs/dyn/run_v1.namespaces.executions.html index d6a836cce7..f93ec5685f 100644 --- a/docs/dyn/run_v1.namespaces.executions.html +++ b/docs/dyn/run_v1.namespaces.executions.html @@ -114,7 +114,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -478,7 +478,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -803,7 +803,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.instances.html b/docs/dyn/run_v1.namespaces.instances.html index 05d9e8dee5..65150085d0 100644 --- a/docs/dyn/run_v1.namespaces.instances.html +++ b/docs/dyn/run_v1.namespaces.instances.html @@ -117,7 +117,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -414,7 +414,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -762,7 +762,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1075,7 +1075,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1384,7 +1384,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1681,7 +1681,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1991,7 +1991,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -2301,7 +2301,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.jobs.html b/docs/dyn/run_v1.namespaces.jobs.html index 875e81cbfc..0fa33d498d 100644 --- a/docs/dyn/run_v1.namespaces.jobs.html +++ b/docs/dyn/run_v1.namespaces.jobs.html @@ -114,7 +114,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -150,7 +150,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -461,7 +461,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -497,7 +497,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -859,7 +859,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -895,7 +895,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1222,7 +1222,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1258,7 +1258,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1581,7 +1581,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1617,7 +1617,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1928,7 +1928,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1964,7 +1964,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -2325,7 +2325,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.revisions.html b/docs/dyn/run_v1.namespaces.revisions.html index 0d02a0c4bf..393bf7ac18 100644 --- a/docs/dyn/run_v1.namespaces.revisions.html +++ b/docs/dyn/run_v1.namespaces.revisions.html @@ -155,7 +155,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case "Revision". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Revision, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -476,7 +476,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case "Revision". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Revision, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.routes.html b/docs/dyn/run_v1.namespaces.routes.html index e969a9d7bc..88e105def4 100644 --- a/docs/dyn/run_v1.namespaces.routes.html +++ b/docs/dyn/run_v1.namespaces.routes.html @@ -107,7 +107,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case always "Route". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Route, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -208,7 +208,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case always "Route". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Route, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.services.html b/docs/dyn/run_v1.namespaces.services.html index 4043fe74c7..4483a75cbc 100644 --- a/docs/dyn/run_v1.namespaces.services.html +++ b/docs/dyn/run_v1.namespaces.services.html @@ -111,7 +111,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/base-images` * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -145,7 +145,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -474,7 +474,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/base-images` * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -508,7 +508,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -888,7 +888,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/base-images` * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -922,7 +922,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1267,7 +1267,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/base-images` * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1301,7 +1301,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1642,7 +1642,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/base-images` * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1676,7 +1676,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -2005,7 +2005,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/base-images` * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -2039,7 +2039,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.tasks.html b/docs/dyn/run_v1.namespaces.tasks.html index a31d4cade1..0686d264b9 100644 --- a/docs/dyn/run_v1.namespaces.tasks.html +++ b/docs/dyn/run_v1.namespaces.tasks.html @@ -107,7 +107,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -435,7 +435,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.workerpools.html b/docs/dyn/run_v1.namespaces.workerpools.html index c212b07383..9b92e8d13f 100644 --- a/docs/dyn/run_v1.namespaces.workerpools.html +++ b/docs/dyn/run_v1.namespaces.workerpools.html @@ -111,7 +111,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "run.googleapis.com/v1". "kind": "A String", # The kind of resource. It must be "WorkerPool". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this WorkerPool, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in WorkerPool.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/description` - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -152,7 +152,7 @@

Method Details

], "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -464,7 +464,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "run.googleapis.com/v1". "kind": "A String", # The kind of resource. It must be "WorkerPool". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this WorkerPool, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in WorkerPool.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/description` - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -505,7 +505,7 @@

Method Details

], "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -865,7 +865,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "run.googleapis.com/v1". "kind": "A String", # The kind of resource. It must be "WorkerPool". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this WorkerPool, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in WorkerPool.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/description` - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -906,7 +906,7 @@

Method Details

], "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1230,7 +1230,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "run.googleapis.com/v1". "kind": "A String", # The kind of resource. It must be "WorkerPool". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this WorkerPool, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in WorkerPool.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/description` - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1271,7 +1271,7 @@

Method Details

], "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1595,7 +1595,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "run.googleapis.com/v1". "kind": "A String", # The kind of resource. It must be "WorkerPool". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this WorkerPool, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in WorkerPool.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/description` - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1636,7 +1636,7 @@

Method Details

], "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1948,7 +1948,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "run.googleapis.com/v1". "kind": "A String", # The kind of resource. It must be "WorkerPool". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this WorkerPool, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in WorkerPool.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/description` - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1989,7 +1989,7 @@

Method Details

], "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.projects.locations.configurations.html b/docs/dyn/run_v1.projects.locations.configurations.html index a22ae4fa88..0b5a4c6832 100644 --- a/docs/dyn/run_v1.projects.locations.configurations.html +++ b/docs/dyn/run_v1.projects.locations.configurations.html @@ -107,7 +107,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of resource, in this case always "Configuration". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Configuration, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -141,7 +141,7 @@

Method Details

"spec": { # ConfigurationSpec holds the desired state of the Configuration (from the client). # Spec holds the desired state of the Configuration (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Template holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -462,7 +462,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of resource, in this case always "Configuration". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Configuration, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -496,7 +496,7 @@

Method Details

"spec": { # ConfigurationSpec holds the desired state of the Configuration (from the client). # Spec holds the desired state of the Configuration (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Template holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.projects.locations.domainmappings.html b/docs/dyn/run_v1.projects.locations.domainmappings.html index 283e57b952..c3b6cb38d5 100644 --- a/docs/dyn/run_v1.projects.locations.domainmappings.html +++ b/docs/dyn/run_v1.projects.locations.domainmappings.html @@ -108,7 +108,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -181,7 +181,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -305,7 +305,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -394,7 +394,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.projects.locations.revisions.html b/docs/dyn/run_v1.projects.locations.revisions.html index a540fd10a4..d70daef461 100644 --- a/docs/dyn/run_v1.projects.locations.revisions.html +++ b/docs/dyn/run_v1.projects.locations.revisions.html @@ -155,7 +155,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case "Revision". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Revision, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -476,7 +476,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case "Revision". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Revision, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.projects.locations.routes.html b/docs/dyn/run_v1.projects.locations.routes.html index 55f0353735..42aa75d263 100644 --- a/docs/dyn/run_v1.projects.locations.routes.html +++ b/docs/dyn/run_v1.projects.locations.routes.html @@ -107,7 +107,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case always "Route". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Route, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -208,7 +208,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case always "Route". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Route, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.projects.locations.services.html b/docs/dyn/run_v1.projects.locations.services.html index b89ca58ad4..9f0b5379dc 100644 --- a/docs/dyn/run_v1.projects.locations.services.html +++ b/docs/dyn/run_v1.projects.locations.services.html @@ -120,7 +120,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/base-images` * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -154,7 +154,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -483,7 +483,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/base-images` * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -517,7 +517,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -897,7 +897,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/base-images` * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -931,7 +931,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1324,7 +1324,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/base-images` * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1358,7 +1358,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1699,7 +1699,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/base-images` * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1733,7 +1733,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -2062,7 +2062,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/base-images` * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -2096,7 +2096,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v2.projects.locations.instances.html b/docs/dyn/run_v2.projects.locations.instances.html index 6730084223..3c9b95cd1b 100644 --- a/docs/dyn/run_v2.projects.locations.instances.html +++ b/docs/dyn/run_v2.projects.locations.instances.html @@ -323,6 +323,7 @@

Method Details

"restartPolicy": "A String", # Optional. Restart policy for the Instance. "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", + "sshEnabled": True or False, # Optional. Enables SSH access to the Instance. "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. @@ -671,6 +672,7 @@

Method Details

"restartPolicy": "A String", # Optional. Restart policy for the Instance. "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", + "sshEnabled": True or False, # Optional. Enables SSH access to the Instance. "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. @@ -1005,6 +1007,7 @@

Method Details

"restartPolicy": "A String", # Optional. Restart policy for the Instance. "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", + "sshEnabled": True or False, # Optional. Enables SSH access to the Instance. "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. @@ -1298,6 +1301,7 @@

Method Details

"restartPolicy": "A String", # Optional. Restart policy for the Instance. "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", + "sshEnabled": True or False, # Optional. Enables SSH access to the Instance. "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. diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.html b/docs/dyn/run_v2.projects.locations.jobs.executions.html index 3dff0cb981..681d5a870f 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.html @@ -478,6 +478,11 @@

Method Details

}, ], }, + "workloadIdentityConfig": { # Workload identity settings. # Optional. The Task's workload identity settings. + "identity": "A String", # Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates. + "identityCertificateEnabled": True or False, # Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag. + "identityType": "A String", # Optional. The type of identity to use. + }, }, "uid": "A String", # Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. @@ -745,6 +750,11 @@

Method Details

}, ], }, + "workloadIdentityConfig": { # Workload identity settings. # Optional. The Task's workload identity settings. + "identity": "A String", # Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates. + "identityCertificateEnabled": True or False, # Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag. + "identityType": "A String", # Optional. The type of identity to use. + }, }, "uid": "A String", # Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. 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 afd56bcdb0..8234ae65d0 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html @@ -355,6 +355,11 @@

Method Details

}, ], }, + "workloadIdentityConfig": { # Workload identity settings. # Optional. The Task's workload identity settings. + "identity": "A String", # Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates. + "identityCertificateEnabled": True or False, # Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag. + "identityType": "A String", # Optional. The type of identity to use. + }, }
@@ -627,6 +632,11 @@

Method Details

}, ], }, + "workloadIdentityConfig": { # Workload identity settings. # Optional. The Task's workload identity settings. + "identity": "A String", # Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates. + "identityCertificateEnabled": True or False, # Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag. + "identityType": "A String", # Optional. The type of identity to use. + }, }, ], }
diff --git a/docs/dyn/run_v2.projects.locations.jobs.html b/docs/dyn/run_v2.projects.locations.jobs.html index 3c7f1fec6e..cce939fe82 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.html +++ b/docs/dyn/run_v2.projects.locations.jobs.html @@ -157,6 +157,7 @@

Method Details

"etag": "A String", # Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. "executionCount": 42, # Output only. Number of executions created for this job. "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted. + "functionalType": "A String", # Optional. The functional type of the Job. "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. "labels": { # Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job. "a_key": "A String", @@ -386,6 +387,11 @@

Method Details

}, ], }, + "workloadIdentityConfig": { # Workload identity settings. # Optional. The Task's workload identity settings. + "identity": "A String", # Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates. + "identityCertificateEnabled": True or False, # Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag. + "identityType": "A String", # Optional. The type of identity to use. + }, }, }, "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. @@ -515,6 +521,7 @@

Method Details

"etag": "A String", # Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. "executionCount": 42, # Output only. Number of executions created for this job. "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted. + "functionalType": "A String", # Optional. The functional type of the Job. "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. "labels": { # Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job. "a_key": "A String", @@ -744,6 +751,11 @@

Method Details

}, ], }, + "workloadIdentityConfig": { # Workload identity settings. # Optional. The Task's workload identity settings. + "identity": "A String", # Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates. + "identityCertificateEnabled": True or False, # Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag. + "identityType": "A String", # Optional. The type of identity to use. + }, }, }, "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. @@ -859,6 +871,7 @@

Method Details

"etag": "A String", # Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. "executionCount": 42, # Output only. Number of executions created for this job. "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted. + "functionalType": "A String", # Optional. The functional type of the Job. "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. "labels": { # Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job. "a_key": "A String", @@ -1088,6 +1101,11 @@

Method Details

}, ], }, + "workloadIdentityConfig": { # Workload identity settings. # Optional. The Task's workload identity settings. + "identity": "A String", # Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates. + "identityCertificateEnabled": True or False, # Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag. + "identityType": "A String", # Optional. The type of identity to use. + }, }, }, "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. @@ -1162,6 +1180,7 @@

Method Details

"etag": "A String", # Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. "executionCount": 42, # Output only. Number of executions created for this job. "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted. + "functionalType": "A String", # Optional. The functional type of the Job. "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. "labels": { # Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job. "a_key": "A String", @@ -1391,6 +1410,11 @@

Method Details

}, ], }, + "workloadIdentityConfig": { # Workload identity settings. # Optional. The Task's workload identity settings. + "identity": "A String", # Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates. + "identityCertificateEnabled": True or False, # Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag. + "identityType": "A String", # Optional. The type of identity to use. + }, }, }, "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. diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index c80e5db36a..398a84d206 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -171,6 +171,7 @@

Method Details

"description": "A String", # User-provided description of the Service. This field currently has a 512-character limit. "etag": "A String", # Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permanently deleted. + "functionalType": "A String", # Optional. The functional type of the Service. "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. "iapEnabled": True or False, # Optional. IAP settings on the Service. "ingress": "A String", # Optional. Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. @@ -419,6 +420,11 @@

Method Details

}, ], }, + "workloadIdentityConfig": { # Workload identity settings. # Optional. The Revision's workload identity settings. + "identity": "A String", # Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates. + "identityCertificateEnabled": True or False, # Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag. + "identityType": "A String", # Optional. The type of identity to use. + }, }, "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. @@ -586,6 +592,7 @@

Method Details

"description": "A String", # User-provided description of the Service. This field currently has a 512-character limit. "etag": "A String", # Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permanently deleted. + "functionalType": "A String", # Optional. The functional type of the Service. "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. "iapEnabled": True or False, # Optional. IAP settings on the Service. "ingress": "A String", # Optional. Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. @@ -834,6 +841,11 @@

Method Details

}, ], }, + "workloadIdentityConfig": { # Workload identity settings. # Optional. The Revision's workload identity settings. + "identity": "A String", # Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates. + "identityCertificateEnabled": True or False, # Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag. + "identityType": "A String", # Optional. The type of identity to use. + }, }, "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. @@ -988,6 +1000,7 @@

Method Details

"description": "A String", # User-provided description of the Service. This field currently has a 512-character limit. "etag": "A String", # Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permanently deleted. + "functionalType": "A String", # Optional. The functional type of the Service. "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. "iapEnabled": True or False, # Optional. IAP settings on the Service. "ingress": "A String", # Optional. Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. @@ -1236,6 +1249,11 @@

Method Details

}, ], }, + "workloadIdentityConfig": { # Workload identity settings. # Optional. The Revision's workload identity settings. + "identity": "A String", # Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates. + "identityCertificateEnabled": True or False, # Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag. + "identityType": "A String", # Optional. The type of identity to use. + }, }, "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. @@ -1350,6 +1368,7 @@

Method Details

"description": "A String", # User-provided description of the Service. This field currently has a 512-character limit. "etag": "A String", # Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permanently deleted. + "functionalType": "A String", # Optional. The functional type of the Service. "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. "iapEnabled": True or False, # Optional. IAP settings on the Service. "ingress": "A String", # Optional. Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. @@ -1598,6 +1617,11 @@

Method Details

}, ], }, + "workloadIdentityConfig": { # Workload identity settings. # Optional. The Revision's workload identity settings. + "identity": "A String", # Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates. + "identityCertificateEnabled": True or False, # Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag. + "identityType": "A String", # Optional. The type of identity to use. + }, }, "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. diff --git a/docs/dyn/run_v2.projects.locations.services.revisions.html b/docs/dyn/run_v2.projects.locations.services.revisions.html index ff7c5a632d..50228d9aa5 100644 --- a/docs/dyn/run_v2.projects.locations.services.revisions.html +++ b/docs/dyn/run_v2.projects.locations.services.revisions.html @@ -434,6 +434,11 @@

Method Details

}, ], }, + "workloadIdentityConfig": { # Workload identity settings. # Optional. The Revision's workload identity settings. + "identity": "A String", # Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates. + "identityCertificateEnabled": True or False, # Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag. + "identityType": "A String", # Optional. The type of identity to use. + }, }
@@ -706,6 +711,11 @@

Method Details

}, ], }, + "workloadIdentityConfig": { # Workload identity settings. # Optional. The Revision's workload identity settings. + "identity": "A String", # Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates. + "identityCertificateEnabled": True or False, # Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag. + "identityType": "A String", # Optional. The type of identity to use. + }, }, ], } diff --git a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html index 3737e1e280..009d6a2b3a 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html @@ -395,6 +395,11 @@

Method Details

}, ], }, + "workloadIdentityConfig": { # Workload identity settings. # Optional. The Revision's workload identity settings. + "identity": "A String", # Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates. + "identityCertificateEnabled": True or False, # Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag. + "identityType": "A String", # Optional. The type of identity to use. + }, }
@@ -667,6 +672,11 @@

Method Details

}, ], }, + "workloadIdentityConfig": { # Workload identity settings. # Optional. The Revision's workload identity settings. + "identity": "A String", # Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates. + "identityCertificateEnabled": True or False, # Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag. + "identityType": "A String", # Optional. The type of identity to use. + }, }, ], } diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index 750821118b..6a38ef0a56 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -3652,7 +3652,7 @@ } } }, -"revision": "20260822", +"revision": "20260904", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -6976,7 +6976,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance.", +"description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance.", "type": "object" }, "clusterName": { diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 9bedf543b9..7d80f73746 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -2669,7 +2669,7 @@ } } }, -"revision": "20260828", +"revision": "20260904", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -3926,6 +3926,10 @@ "serviceAccount": { "type": "string" }, +"sshEnabled": { +"description": "Optional. Enables SSH access to the Instance.", +"type": "boolean" +}, "terminalCondition": { "$ref": "GoogleCloudRunV2Condition", "description": "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.", @@ -4088,6 +4092,20 @@ "readOnly": true, "type": "string" }, +"functionalType": { +"description": "Optional. The functional type of the Job.", +"enum": [ +"FUNCTIONAL_TYPE_UNSPECIFIED", +"FUNCTIONAL_TYPE_AGENT", +"FUNCTIONAL_TYPE_MCP_SERVER" +], +"enumDescriptions": [ +"Specifies that the functional type is unspecified.", +"Represents an AGENT functional type.", +"Represents an MCP_SERVER functional type." +], +"type": "string" +}, "generation": { "description": "Output only. A number that monotonically increases every time the user modifies the desired state.", "format": "int64", @@ -4722,6 +4740,10 @@ "vpcAccess": { "$ref": "GoogleCloudRunV2VpcAccess", "description": "VPC Access configuration for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc." +}, +"workloadIdentityConfig": { +"$ref": "GoogleCloudRunV2WorkloadIdentityConfig", +"description": "Optional. The Revision's workload identity settings." } }, "type": "object" @@ -4887,6 +4909,10 @@ "vpcAccess": { "$ref": "GoogleCloudRunV2VpcAccess", "description": "Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc." +}, +"workloadIdentityConfig": { +"$ref": "GoogleCloudRunV2WorkloadIdentityConfig", +"description": "Optional. The Revision's workload identity settings." } }, "type": "object" @@ -5025,6 +5051,20 @@ "readOnly": true, "type": "string" }, +"functionalType": { +"description": "Optional. The functional type of the Service.", +"enum": [ +"FUNCTIONAL_TYPE_UNSPECIFIED", +"FUNCTIONAL_TYPE_AGENT", +"FUNCTIONAL_TYPE_MCP_SERVER" +], +"enumDescriptions": [ +"Specifies that the functional type is unspecified.", +"Represents an AGENT functional type.", +"Represents an MCP_SERVER functional type." +], +"type": "string" +}, "generation": { "description": "Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.", "format": "int64", @@ -5619,6 +5659,10 @@ "$ref": "GoogleCloudRunV2VpcAccess", "description": "Output only. VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.", "readOnly": true +}, +"workloadIdentityConfig": { +"$ref": "GoogleCloudRunV2WorkloadIdentityConfig", +"description": "Optional. The Task's workload identity settings." } }, "type": "object" @@ -5708,6 +5752,10 @@ "vpcAccess": { "$ref": "GoogleCloudRunV2VpcAccess", "description": "Optional. VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc." +}, +"workloadIdentityConfig": { +"$ref": "GoogleCloudRunV2WorkloadIdentityConfig", +"description": "Optional. The Task's workload identity settings." } }, "type": "object" @@ -6199,6 +6247,35 @@ }, "type": "object" }, +"GoogleCloudRunV2WorkloadIdentityConfig": { +"description": "Workload identity settings.", +"id": "GoogleCloudRunV2WorkloadIdentityConfig", +"properties": { +"identity": { +"description": "Optional. The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates.", +"type": "string" +}, +"identityCertificateEnabled": { +"description": "Optional. Controls whether an instance receives a MWLID certificate. Corresponds to the intention of the original --[no-]identity-certificate flag.", +"type": "boolean" +}, +"identityType": { +"description": "Optional. The type of identity to use.", +"enum": [ +"IDENTITY_TYPE_UNSPECIFIED", +"IDENTITY_TYPE_SERVICE_ACCOUNT", +"IDENTITY_TYPE_AGENT_IDENTITY" +], +"enumDescriptions": [ +"Unspecified", +"Service account identity.", +"Agent identity." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleDevtoolsCloudbuildV1ApprovalConfig": { "description": "ApprovalConfig describes configuration for manual approval of a build.", "id": "GoogleDevtoolsCloudbuildV1ApprovalConfig", From 27f9338abde9c7cc9b3d029e49653378d9c0b508 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:30 +0000 Subject: [PATCH 28/30] feat(webcontentpublisher): update the api #### webcontentpublisher:v1 The following keys were added: - resources.organizations.resources.publications.methods.create.scopes (Total Keys: 1) - resources.organizations.resources.publications.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.publications.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.publications.methods.patch.scopes (Total Keys: 1) - resources.organizations.resources.publications.resources.ctas.methods.create.scopes (Total Keys: 1) - resources.organizations.resources.publications.resources.ctas.methods.get.scopes (Total Keys: 1) - resources.organizations.resources.publications.resources.ctas.methods.list.scopes (Total Keys: 1) - resources.organizations.resources.publications.resources.ctas.methods.patch.scopes (Total Keys: 1) --- .../documents/webcontentpublisher.v1.json | 51 +++++++++++++++---- 1 file changed, 42 insertions(+), 9 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json b/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json index 4f3575950d..4d0ee0ee50 100644 --- a/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json +++ b/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json @@ -1,4 +1,13 @@ { +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/webcontentpublisher.publications.manage.system": { +"description": "Private Service: https://www.googleapis.com/auth/webcontentpublisher.publications.manage.system" +} +} +} +}, "basePath": "", "baseUrl": "https://webcontentpublisher.googleapis.com/", "batchPath": "batch", @@ -128,7 +137,10 @@ }, "response": { "$ref": "Publication" -} +}, +"scopes": [ +"https://www.googleapis.com/auth/webcontentpublisher.publications.manage.system" +] }, "get": { "description": "Gets a publication.", @@ -150,7 +162,10 @@ "path": "v1/{+name}", "response": { "$ref": "Publication" -} +}, +"scopes": [ +"https://www.googleapis.com/auth/webcontentpublisher.publications.manage.system" +] }, "list": { "description": "Lists publications.", @@ -188,7 +203,10 @@ "path": "v1/{+parent}/publications", "response": { "$ref": "ListPublicationsResponse" -} +}, +"scopes": [ +"https://www.googleapis.com/auth/webcontentpublisher.publications.manage.system" +] }, "patch": { "description": "Updates a publication.", @@ -219,7 +237,10 @@ }, "response": { "$ref": "Publication" -} +}, +"scopes": [ +"https://www.googleapis.com/auth/webcontentpublisher.publications.manage.system" +] } }, "resources": { @@ -253,7 +274,10 @@ }, "response": { "$ref": "Cta" -} +}, +"scopes": [ +"https://www.googleapis.com/auth/webcontentpublisher.publications.manage.system" +] }, "get": { "description": "Gets a CTA.", @@ -275,7 +299,10 @@ "path": "v1/{+name}", "response": { "$ref": "Cta" -} +}, +"scopes": [ +"https://www.googleapis.com/auth/webcontentpublisher.publications.manage.system" +] }, "list": { "description": "Lists CTAs.", @@ -308,7 +335,10 @@ "path": "v1/{+parent}/ctas", "response": { "$ref": "ListCtasResponse" -} +}, +"scopes": [ +"https://www.googleapis.com/auth/webcontentpublisher.publications.manage.system" +] }, "patch": { "description": "Updates a CTA.", @@ -339,7 +369,10 @@ }, "response": { "$ref": "Cta" -} +}, +"scopes": [ +"https://www.googleapis.com/auth/webcontentpublisher.publications.manage.system" +] } } } @@ -413,7 +446,7 @@ } } }, -"revision": "20260902", +"revision": "20260906", "rootUrl": "https://webcontentpublisher.googleapis.com/", "schemas": { "CheckFreeAccessResponse": { From 1340ff8e24b6edbd3397566bc91a7f2d49818d0d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:31 +0000 Subject: [PATCH 29/30] fix(workstations): update the api #### workstations:v1 The following keys were changed: - endpoints (Total Keys: 1) #### workstations:v1beta The following keys were changed: - endpoints (Total Keys: 1) --- .../documents/workstations.v1.json | 27 ++++++++++++++++++- .../documents/workstations.v1beta.json | 27 ++++++++++++++++++- 2 files changed, 52 insertions(+), 2 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/workstations.v1.json b/googleapiclient/discovery_cache/documents/workstations.v1.json index c3cdcf9c29..09ef55948a 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1.json @@ -20,6 +20,31 @@ "description": "Regional Endpoint", "endpointUrl": "https://workstations.us-central1.rep.googleapis.com/", "location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workstations.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workstations.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workstations.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workstations.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workstations.us-west4.rep.googleapis.com/", +"location": "us-west4" } ], "fullyEncodeReservedExpansion": true, @@ -1256,7 +1281,7 @@ } } }, -"revision": "20260901", +"revision": "20260909", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { diff --git a/googleapiclient/discovery_cache/documents/workstations.v1beta.json b/googleapiclient/discovery_cache/documents/workstations.v1beta.json index c0f8e32987..bd16165169 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1beta.json @@ -20,6 +20,31 @@ "description": "Regional Endpoint", "endpointUrl": "https://workstations.us-central1.rep.googleapis.com/", "location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workstations.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workstations.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workstations.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workstations.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workstations.us-west4.rep.googleapis.com/", +"location": "us-west4" } ], "fullyEncodeReservedExpansion": true, @@ -1210,7 +1235,7 @@ } } }, -"revision": "20260901", +"revision": "20260909", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { From 35175d917ed2149b6cf52228f162c75cf6e0f2da Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 15 Sep 2026 07:22:31 +0000 Subject: [PATCH 30/30] chore(docs): Add new discovery artifacts and artifacts with minor updates --- ...icsadmin_v1alpha.properties.keyEvents.html | 4 +- ...ticsadmin_v1beta.properties.keyEvents.html | 4 +- ...ndroidpublisher_v3.appstoreappsreview.html | 2 +- docs/dyn/auditmanager_v1.folders.html | 91 + ...ger_v1.folders.locations.auditReports.html | 291 + ...1.folders.locations.auditScopeReports.html | 119 + .../auditmanager_v1.folders.locations.html | 155 + ...v1.folders.locations.operationDetails.html | 124 + ...ger_v1.folders.locations.operationIds.html | 124 + ....locations.resourceEnrollmentStatuses.html | 176 + ....folders.locations.standards.controls.html | 144 + ...anager_v1.folders.locations.standards.html | 91 + docs/dyn/auditmanager_v1.html | 121 + docs/dyn/auditmanager_v1.organizations.html | 91 + ....organizations.locations.auditReports.html | 291 + ...nizations.locations.auditScopeReports.html | 119 + ...ditmanager_v1.organizations.locations.html | 160 + ...anizations.locations.operationDetails.html | 124 + ....organizations.locations.operationIds.html | 124 + ...v1.organizations.locations.operations.html | 239 + ....locations.resourceEnrollmentStatuses.html | 176 + ...izations.locations.standards.controls.html | 144 + ..._v1.organizations.locations.standards.html | 91 + docs/dyn/auditmanager_v1.projects.html | 91 + ...er_v1.projects.locations.auditReports.html | 291 + ....projects.locations.auditScopeReports.html | 119 + .../auditmanager_v1.projects.locations.html | 246 + ...1.projects.locations.operationDetails.html | 124 + ...er_v1.projects.locations.operationIds.html | 124 + ...ager_v1.projects.locations.operations.html | 239 + ....locations.resourceEnrollmentStatuses.html | 119 + ...projects.locations.standards.controls.html | 144 + ...nager_v1.projects.locations.standards.html | 91 + docs/dyn/backupdr_v1beta.folders.html | 91 + .../backupdr_v1beta.folders.locations.html | 91 + ...lders.locations.resourceBackupConfigs.html | 175 + docs/dyn/backupdr_v1beta.html | 121 + docs/dyn/backupdr_v1beta.organizations.html | 91 + ...ckupdr_v1beta.organizations.locations.html | 91 + ...tions.locations.resourceBackupConfigs.html | 175 + docs/dyn/backupdr_v1beta.projects.html | 91 + ...cations.appliedAutoProtectionPolicies.html | 164 + ...tions.autoProtectionPolicies.bindings.html | 287 + ...onPolicies.bindings.matchingResources.html | 188 + ...ects.locations.autoProtectionPolicies.html | 419 + ...ects.locations.backupPlanAssociations.html | 566 ++ ...v1beta.projects.locations.backupPlans.html | 505 + ...jects.locations.backupPlans.revisions.html | 273 + ...ions.backupVaults.dataSources.backups.html | 1621 ++++ ...ts.locations.backupVaults.dataSources.html | 740 ++ ...1beta.projects.locations.backupVaults.html | 515 + ...ojects.locations.dataSourceReferences.html | 289 + .../backupdr_v1beta.projects.locations.html | 253 + ....projects.locations.managementServers.html | 545 ++ ..._v1beta.projects.locations.operations.html | 239 + ...jects.locations.resourceBackupConfigs.html | 264 + ...beta.projects.locations.serviceConfig.html | 137 + ...kupdr_v1beta.projects.locations.trial.html | 151 + docs/dyn/docs_v1.documents.html | 6 +- ...gkehub_v1.projects.locations.rollouts.html | 4 +- ...b_v1alpha.projects.locations.rollouts.html | 4 +- ...ub_v1beta.projects.locations.rollouts.html | 4 +- ...y_v1.projects.locations.authzPolicies.html | 32 +- ...eta1.projects.locations.authzPolicies.html | 32 +- ...rojects.locations.autonomousDatabases.html | 2 +- ...v1.projects.locations.exadbVmClusters.html | 2 +- docs/dyn/storage_v1.objects.html | 16 + .../documents/analyticsadmin.v1alpha.json | 4 +- .../documents/analyticsadmin.v1beta.json | 4 +- .../documents/androidpublisher.v3.json | 8 +- .../documents/auditmanager.v1.json | 2225 +++++ .../documents/backupdr.v1beta.json | 8329 +++++++++++++++++ .../discovery_cache/documents/docs.v1.json | 4 +- .../discovery_cache/documents/gkehub.v1.json | 4 +- .../documents/gkehub.v1alpha.json | 4 +- .../documents/gkehub.v1beta.json | 4 +- .../discovery_cache/documents/iam.v1.json | 10 +- .../documents/networksecurity.v1.json | 4 +- .../documents/networksecurity.v1beta1.json | 4 +- .../documents/oracledatabase.v1.json | 6 +- .../discovery_cache/documents/storage.v1.json | 8 +- 81 files changed, 23318 insertions(+), 77 deletions(-) create mode 100644 docs/dyn/auditmanager_v1.folders.html create mode 100644 docs/dyn/auditmanager_v1.folders.locations.auditReports.html create mode 100644 docs/dyn/auditmanager_v1.folders.locations.auditScopeReports.html create mode 100644 docs/dyn/auditmanager_v1.folders.locations.html create mode 100644 docs/dyn/auditmanager_v1.folders.locations.operationDetails.html create mode 100644 docs/dyn/auditmanager_v1.folders.locations.operationIds.html create mode 100644 docs/dyn/auditmanager_v1.folders.locations.resourceEnrollmentStatuses.html create mode 100644 docs/dyn/auditmanager_v1.folders.locations.standards.controls.html create mode 100644 docs/dyn/auditmanager_v1.folders.locations.standards.html create mode 100644 docs/dyn/auditmanager_v1.html create mode 100644 docs/dyn/auditmanager_v1.organizations.html create mode 100644 docs/dyn/auditmanager_v1.organizations.locations.auditReports.html create mode 100644 docs/dyn/auditmanager_v1.organizations.locations.auditScopeReports.html create mode 100644 docs/dyn/auditmanager_v1.organizations.locations.html create mode 100644 docs/dyn/auditmanager_v1.organizations.locations.operationDetails.html create mode 100644 docs/dyn/auditmanager_v1.organizations.locations.operationIds.html create mode 100644 docs/dyn/auditmanager_v1.organizations.locations.operations.html create mode 100644 docs/dyn/auditmanager_v1.organizations.locations.resourceEnrollmentStatuses.html create mode 100644 docs/dyn/auditmanager_v1.organizations.locations.standards.controls.html create mode 100644 docs/dyn/auditmanager_v1.organizations.locations.standards.html create mode 100644 docs/dyn/auditmanager_v1.projects.html create mode 100644 docs/dyn/auditmanager_v1.projects.locations.auditReports.html create mode 100644 docs/dyn/auditmanager_v1.projects.locations.auditScopeReports.html create mode 100644 docs/dyn/auditmanager_v1.projects.locations.html create mode 100644 docs/dyn/auditmanager_v1.projects.locations.operationDetails.html create mode 100644 docs/dyn/auditmanager_v1.projects.locations.operationIds.html create mode 100644 docs/dyn/auditmanager_v1.projects.locations.operations.html create mode 100644 docs/dyn/auditmanager_v1.projects.locations.resourceEnrollmentStatuses.html create mode 100644 docs/dyn/auditmanager_v1.projects.locations.standards.controls.html create mode 100644 docs/dyn/auditmanager_v1.projects.locations.standards.html create mode 100644 docs/dyn/backupdr_v1beta.folders.html create mode 100644 docs/dyn/backupdr_v1beta.folders.locations.html create mode 100644 docs/dyn/backupdr_v1beta.folders.locations.resourceBackupConfigs.html create mode 100644 docs/dyn/backupdr_v1beta.html create mode 100644 docs/dyn/backupdr_v1beta.organizations.html create mode 100644 docs/dyn/backupdr_v1beta.organizations.locations.html create mode 100644 docs/dyn/backupdr_v1beta.organizations.locations.resourceBackupConfigs.html create mode 100644 docs/dyn/backupdr_v1beta.projects.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.appliedAutoProtectionPolicies.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.bindings.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.bindings.matchingResources.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.backupPlanAssociations.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.backupPlans.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.backupPlans.revisions.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.backupVaults.dataSources.backups.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.backupVaults.dataSources.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.backupVaults.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.dataSourceReferences.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.managementServers.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.operations.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.resourceBackupConfigs.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.serviceConfig.html create mode 100644 docs/dyn/backupdr_v1beta.projects.locations.trial.html create mode 100644 googleapiclient/discovery_cache/documents/auditmanager.v1.json create mode 100644 googleapiclient/discovery_cache/documents/backupdr.v1beta.json diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.keyEvents.html b/docs/dyn/analyticsadmin_v1alpha.properties.keyEvents.html index 29215ce9a5..2aacae4622 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.keyEvents.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.keyEvents.html @@ -85,7 +85,7 @@

Instance Methods

Deletes a Key Event.

get(name, x__xgafv=None)

-

Retrieve a single Key Event.

+

Retrieves a single Key Event.

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

Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.

@@ -165,7 +165,7 @@

Method Details

get(name, x__xgafv=None) -
Retrieve a single Key Event.
+  
Retrieves a single Key Event.
 
 Args:
   name: string, Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456" (required)
diff --git a/docs/dyn/analyticsadmin_v1beta.properties.keyEvents.html b/docs/dyn/analyticsadmin_v1beta.properties.keyEvents.html
index b2d66421b4..bf94e40889 100644
--- a/docs/dyn/analyticsadmin_v1beta.properties.keyEvents.html
+++ b/docs/dyn/analyticsadmin_v1beta.properties.keyEvents.html
@@ -85,7 +85,7 @@ 

Instance Methods

Deletes a Key Event.

get(name, x__xgafv=None)

-

Retrieve a single Key Event.

+

Retrieves a single Key Event.

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

Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.

@@ -165,7 +165,7 @@

Method Details

get(name, x__xgafv=None) -
Retrieve a single Key Event.
+  
Retrieves a single Key Event.
 
 Args:
   name: string, Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456" (required)
diff --git a/docs/dyn/androidpublisher_v3.appstoreappsreview.html b/docs/dyn/androidpublisher_v3.appstoreappsreview.html
index a84666d708..25819bc8cc 100644
--- a/docs/dyn/androidpublisher_v3.appstoreappsreview.html
+++ b/docs/dyn/androidpublisher_v3.appstoreappsreview.html
@@ -138,7 +138,7 @@ 

Method Details

{ # 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. + { # An installable set of active APKs. All APKs in this set should belong to the same version of the app. 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", diff --git a/docs/dyn/auditmanager_v1.folders.html b/docs/dyn/auditmanager_v1.folders.html new file mode 100644 index 0000000000..db5bae4c57 --- /dev/null +++ b/docs/dyn/auditmanager_v1.folders.html @@ -0,0 +1,91 @@ + + + +

Audit Manager 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/auditmanager_v1.folders.locations.auditReports.html b/docs/dyn/auditmanager_v1.folders.locations.auditReports.html new file mode 100644 index 0000000000..2d51010b38 --- /dev/null +++ b/docs/dyn/auditmanager_v1.folders.locations.auditReports.html @@ -0,0 +1,291 @@ + + + +

Audit Manager API . folders . locations . auditReports

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Registers audit report generation requests. This method returns the operation identifier that you can use to track the report generation progress.

+

+ get(name, x__xgafv=None)

+

Gets the full metadata and findings for an audit report.

+

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

+

Lists the audit reports for the organization, folder, or project that you specify as the parent scope.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ generate(scope, body=None, x__xgafv=None) +
Registers audit report generation requests. This method returns the operation identifier that you can use to track the report generation progress.
+
+Args:
+  scope: string, Required. Organization, folder, or project that the audit applies to, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for GenerateAuditReport.
+  "complianceFramework": "A String", # Required. The framework that's used for the audit report. For example, `NIST_800_53`.
+  "complianceStandard": "A String", # Optional. Deprecated. Compliance standard for the audit report. Use the `compliance_framework` field instead.
+  "gcsUri": "A String", # URL for the Cloud Storage bucket where the report and evidence is uploaded. You must select a bucket that was provided during the enrollment process.
+  "reportFormat": "A String", # Required. Format for the audit report.
+  "validateOnly": True or False, # Optional. If `true`, only validates the request and does not generate the audit report. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase. Use this field for the following purposes: * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run dry-run mutations (e.g., `terraform plan`) without creating real resources or incurring costs. * **User Interface Validation**: Enable real-time form and permission validation in custom UIs before submitting requests. * **CI/CD & Automation**: Test your scripts, permissions, and parameters safely without triggering expensive Long-Running Operations (LROs) or consuming resource quotas.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the full metadata and findings for an audit report.
+
+Args:
+  name: string, Required. Name of the audit report, in one of the following formats: * `projects/{project}/locations/{location}/auditReports/{audit_report}` * `folders/{folder}/locations/{location}/auditReports/{audit_report}` * `organizations/{organization}/locations/{location}/auditReports/{audit_report}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An audit report.
+  "complianceFramework": "A String", # Output only. Compliance framework to use for the audit report. For example, `CIS_GCP_FOUNDATIONS_V1_2_0`.
+  "complianceStandard": "A String", # Output only. Deprecated. Compliance standard to be audited against. Use the `compliance_framework` field instead.
+  "controlDetails": [ # Output only. Overall status of the controls.
+    { # Evaluation details for a control.
+      "complianceState": "A String", # Output only. Overall status of the findings for the control.
+      "control": { # A control. # Control that the findings are being reported for.
+        "controlFamily": { # Regulatory family of the control. # Output only. Regulatory family of the control.
+          "displayName": "A String", # Display name of the regulatory control family.
+          "familyId": "A String", # ID of the regulatory control family. To find the list of supported control families, use the ListControls method and review the `control_family` field in the response.
+        },
+        "customerResponsibilityDescription": "A String", # Output only. A description of your responsibility for this control.
+        "customerResponsibilityImplementation": "A String", # Output only. A description of how you can implement your responsibility for this control.
+        "description": "A String", # Output only. Description of the control.
+        "displayName": "A String", # Output only. Display name of the control.
+        "family": "A String", # Output only. Category that the control belongs to.
+        "googleResponsibilityDescription": "A String", # Output only. A description of Google's responsibility for this control.
+        "googleResponsibilityImplementation": "A String", # Output only. A description of how Google implements its responsibility for this control.
+        "id": "A String", # Output only. Control identifier that's used to fetch the findings. The identifier is the same as the control report name.
+        "responsibilityType": "A String", # Output only. Who is responsible for implementing this control. Set to one of the following values: `GOOGLE`, `CUSTOMER`, or `SHARED`.
+      },
+      "controlReportSummary": { # Additional information about the number of checks that were made during an audit operation. # A control report summary that provides a high-level overview of the compliance controls and the assessment status.
+        "compliantCount": 42, # Number of compliant checks.
+        "errorCount": 42, # Number of checks that can't be performed due to errors.
+        "manualReviewNeededCount": 42, # Number of checks that require a manual review.
+        "totalCount": 42, # Total number of evaluated checks.
+        "violationCount": 42, # Number of checks with violations.
+      },
+    },
+  ],
+  "createTime": "A String", # Output only. Creation time of the audit report.
+  "destinationDetails": { # Cloud Storage bucket where the audit report is uploaded to. # Output only. Cloud Storage bucket where the audit report is uploaded to.
+    "gcsBucketUri": "A String", # URI for the Cloud Storage bucket, in the format `gs://{bucket_name}`.
+  },
+  "name": "A String", # Identifier. Name of the audit report, in one of the following formats: * `projects/{project}/locations/{location}/auditReports/{audit_report}` * `folders/{folder}/locations/{location}/auditReports/{audit_report}` * `organizations/{organization}/locations/{location}/auditReports/{audit_report}`
+  "operationId": "A String", # Output only. Client operation ID for the audit report.
+  "reportGenerationState": "A String", # Output only. State of audit report generation.
+  "reportSummary": { # Additional information about the number of checks that were made during an audit operation. # Output only. Report summary that includes information about compliance and violation counts.
+    "compliantCount": 42, # Number of compliant checks.
+    "errorCount": 42, # Number of checks that can't be performed due to errors.
+    "manualReviewNeededCount": 42, # Number of checks that require a manual review.
+    "totalCount": 42, # Total number of evaluated checks.
+    "violationCount": 42, # Number of checks with violations.
+  },
+  "scope": "A String", # Output only. Organization, folder, or project that the report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
+  "scopeId": "A String", # Output only. Project number, folder ID, or organization ID that the audit report was generated for.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the audit reports for the organization, folder, or project that you specify as the parent scope.
+
+Args:
+  parent: string, Required. Parent organization, folder, or project to list reports for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}` (required)
+  pageSize: integer, Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
+  pageToken: string, Optional. A page token, received from a previous call, to retrieve the next page of 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 ListAuditReports.
+  "auditReports": [ # Output only. Audit reports.
+    { # An audit report.
+      "complianceFramework": "A String", # Output only. Compliance framework to use for the audit report. For example, `CIS_GCP_FOUNDATIONS_V1_2_0`.
+      "complianceStandard": "A String", # Output only. Deprecated. Compliance standard to be audited against. Use the `compliance_framework` field instead.
+      "controlDetails": [ # Output only. Overall status of the controls.
+        { # Evaluation details for a control.
+          "complianceState": "A String", # Output only. Overall status of the findings for the control.
+          "control": { # A control. # Control that the findings are being reported for.
+            "controlFamily": { # Regulatory family of the control. # Output only. Regulatory family of the control.
+              "displayName": "A String", # Display name of the regulatory control family.
+              "familyId": "A String", # ID of the regulatory control family. To find the list of supported control families, use the ListControls method and review the `control_family` field in the response.
+            },
+            "customerResponsibilityDescription": "A String", # Output only. A description of your responsibility for this control.
+            "customerResponsibilityImplementation": "A String", # Output only. A description of how you can implement your responsibility for this control.
+            "description": "A String", # Output only. Description of the control.
+            "displayName": "A String", # Output only. Display name of the control.
+            "family": "A String", # Output only. Category that the control belongs to.
+            "googleResponsibilityDescription": "A String", # Output only. A description of Google's responsibility for this control.
+            "googleResponsibilityImplementation": "A String", # Output only. A description of how Google implements its responsibility for this control.
+            "id": "A String", # Output only. Control identifier that's used to fetch the findings. The identifier is the same as the control report name.
+            "responsibilityType": "A String", # Output only. Who is responsible for implementing this control. Set to one of the following values: `GOOGLE`, `CUSTOMER`, or `SHARED`.
+          },
+          "controlReportSummary": { # Additional information about the number of checks that were made during an audit operation. # A control report summary that provides a high-level overview of the compliance controls and the assessment status.
+            "compliantCount": 42, # Number of compliant checks.
+            "errorCount": 42, # Number of checks that can't be performed due to errors.
+            "manualReviewNeededCount": 42, # Number of checks that require a manual review.
+            "totalCount": 42, # Total number of evaluated checks.
+            "violationCount": 42, # Number of checks with violations.
+          },
+        },
+      ],
+      "createTime": "A String", # Output only. Creation time of the audit report.
+      "destinationDetails": { # Cloud Storage bucket where the audit report is uploaded to. # Output only. Cloud Storage bucket where the audit report is uploaded to.
+        "gcsBucketUri": "A String", # URI for the Cloud Storage bucket, in the format `gs://{bucket_name}`.
+      },
+      "name": "A String", # Identifier. Name of the audit report, in one of the following formats: * `projects/{project}/locations/{location}/auditReports/{audit_report}` * `folders/{folder}/locations/{location}/auditReports/{audit_report}` * `organizations/{organization}/locations/{location}/auditReports/{audit_report}`
+      "operationId": "A String", # Output only. Client operation ID for the audit report.
+      "reportGenerationState": "A String", # Output only. State of audit report generation.
+      "reportSummary": { # Additional information about the number of checks that were made during an audit operation. # Output only. Report summary that includes information about compliance and violation counts.
+        "compliantCount": 42, # Number of compliant checks.
+        "errorCount": 42, # Number of checks that can't be performed due to errors.
+        "manualReviewNeededCount": 42, # Number of checks that require a manual review.
+        "totalCount": 42, # Total number of evaluated checks.
+        "violationCount": 42, # Number of checks with violations.
+      },
+      "scope": "A String", # Output only. Organization, folder, or project that the report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
+      "scopeId": "A String", # Output only. Project number, folder ID, or organization ID that the audit report was generated for.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. A token that you can send as the `page_token` in a subsequent request to retrieve the next page of results. If this field is empty, there are no subsequent pages.
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.folders.locations.auditScopeReports.html b/docs/dyn/auditmanager_v1.folders.locations.auditScopeReports.html new file mode 100644 index 0000000000..4a19c91203 --- /dev/null +++ b/docs/dyn/auditmanager_v1.folders.locations.auditScopeReports.html @@ -0,0 +1,119 @@ + + + +

Audit Manager API . folders . locations . auditScopeReports

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Generates an audit scope report for the given standard. The report includes the following: * The technical attributes and constraints that Audit Manager uses to verify your compliance with a framework. * A list of Google Cloud services and resources that are within the scope of the framework.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ generate(scope, body=None, x__xgafv=None) +
Generates an audit scope report for the given standard. The report includes the following: * The technical attributes and constraints that Audit Manager uses to verify your compliance with a framework. * A list of Google Cloud services and resources that are within the scope of the framework.
+
+Args:
+  scope: string, Required. Project or folder that the audit scope report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for GenerateAuditScopeReport.
+  "complianceFramework": "A String", # Required. Framework (set of controls) that the audit scope report is generated against. For example, `NIST_800_53`.
+  "complianceStandard": "A String", # Optional. Deprecated. The standard (industry or regulatory requirements) that the audit scope report is run against. Use the `compliance_framework` field instead.
+  "reportFormat": "A String", # Required. Format for the audit scope report.
+  "validateOnly": True or False, # Optional. If `true`, only validates the request and does not generate the audit scope report. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase. Use this field for the following purposes: * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run dry-run mutations (e.g., `terraform plan`) without creating real resources or incurring costs. * **User Interface Validation**: Enable real-time form and permission validation in custom UIs before submitting requests. * **CI/CD & Automation**: Test your scripts, permissions, and parameters safely without consuming resource quotas.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Audit scope report.
+  "name": "A String", # Identifier. Name for the audit scope report, in one of the following formats: * `projects/{project}/locations/{location}/auditScopeReports/{audit_scope_report}` * `folders/{folder}/locations/{location}/auditScopeReports/{audit_scope_report}` * `organizations/{organization}/locations/{location}/auditScopeReports/{audit_scope_report}`
+  "scopeReportContents": "A String", # Audit scope report content in byte format.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.folders.locations.html b/docs/dyn/auditmanager_v1.folders.locations.html new file mode 100644 index 0000000000..dc773a149c --- /dev/null +++ b/docs/dyn/auditmanager_v1.folders.locations.html @@ -0,0 +1,155 @@ + + + +

Audit Manager API . folders . locations

+

Instance Methods

+

+ auditReports() +

+

Returns the auditReports Resource.

+ +

+ auditScopeReports() +

+

Returns the auditScopeReports Resource.

+ +

+ operationDetails() +

+

Returns the operationDetails Resource.

+ +

+ operationIds() +

+

Returns the operationIds Resource.

+ +

+ resourceEnrollmentStatuses() +

+

Returns the resourceEnrollmentStatuses Resource.

+ +

+ standards() +

+

Returns the standards Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ enrollResource(scope, body=None, x__xgafv=None)

+

Adds your project, folder, or organization to Audit Manager. This method creates the Audit Manager service agent in your workload and grants required permissions to the service agent. If you make this request on a workload that's already enrolled, then this method overrides the existing set of destinations.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ enrollResource(scope, body=None, x__xgafv=None) +
Adds your project, folder, or organization to Audit Manager. This method creates the Audit Manager service agent in your workload and grants required permissions to the service agent. If you make this request on a workload that's already enrolled, then this method overrides the existing set of destinations.
+
+Args:
+  scope: string, Required. Organization, folder, or project to enroll in Audit Manager, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for EnrollResource.
+  "destinations": [ # Required. Cloud Storage buckets that you can upload your audit reports to during the audit process. When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.
+    { # Details about the bucket where you want to upload the audit report.
+      "eligibleGcsBucket": "A String", # The location of the Cloud Storage bucket where you want to upload the audit report and evidence during the GenerateAuditReport API call.
+    },
+  ],
+  "validateOnly": True or False, # Optional. If `true`, only validates the request and does not enroll the resource. This executes standard request validation (such as schema, IAM, and destination checks) and skips the apply phase. Use this field for the following purposes: * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run dry-run mutations (e.g., `terraform plan`) without creating real resources or incurring costs. * **User Interface Validation**: Enable real-time form and permission validation in custom UIs before submitting requests. * **CI/CD & Automation**: Test your scripts, permissions, and parameters safely without consuming resource quotas.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Organization, folder, or project to enroll for audit reports.
+  "destinationDetails": [ # Output only. Cloud Storage buckets where you want to upload the audit reports.
+    { # Cloud Storage bucket where the audit report is uploaded to.
+      "gcsBucketUri": "A String", # URI for the Cloud Storage bucket, in the format `gs://{bucket_name}`.
+    },
+  ],
+  "name": "A String", # Identifier. Name of the enrollment, in one of the following formats: * `projects/{project}/locations/{location}/enrollments/{enrollment}` * `folders/{folder}/locations/{location}/enrollments/{enrollment}` * `organizations/{organization}/locations/{location}/enrollments/{enrollment}`
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.folders.locations.operationDetails.html b/docs/dyn/auditmanager_v1.folders.locations.operationDetails.html new file mode 100644 index 0000000000..bca9ef057a --- /dev/null +++ b/docs/dyn/auditmanager_v1.folders.locations.operationDetails.html @@ -0,0 +1,124 @@ + + + +

Audit Manager API . folders . locations . operationDetails

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details about the long-running operation to generate audit reports.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details about the long-running operation to generate audit reports.
+
+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/auditmanager_v1.folders.locations.operationIds.html b/docs/dyn/auditmanager_v1.folders.locations.operationIds.html new file mode 100644 index 0000000000..0eea3c66be --- /dev/null +++ b/docs/dyn/auditmanager_v1.folders.locations.operationIds.html @@ -0,0 +1,124 @@ + + + +

Audit Manager API . folders . locations . operationIds

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details about the long-running operation to generate audit reports.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details about the long-running operation to generate audit reports.
+
+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/auditmanager_v1.folders.locations.resourceEnrollmentStatuses.html b/docs/dyn/auditmanager_v1.folders.locations.resourceEnrollmentStatuses.html new file mode 100644 index 0000000000..8965132844 --- /dev/null +++ b/docs/dyn/auditmanager_v1.folders.locations.resourceEnrollmentStatuses.html @@ -0,0 +1,176 @@ + + + +

Audit Manager API . folders . locations . resourceEnrollmentStatuses

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a resource and its enrollment status.

+

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

+

Lists all the folders and projects in an organization or folder, along with their enrollments.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a resource and its enrollment status.
+
+Args:
+  name: string, Required. Name of the resource enrollment status, in one of the following formats: * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An organization, folder, or project with its enrollment status.
+  "displayName": "A String", # Output only. Display name for the organization, folder, or project.
+  "enrolled": True or False, # Output only. Deprecated. Whether the organization, folder, or project is enrolled. Use `enrollment_state` instead.
+  "enrollment": { # Organization, folder, or project to enroll for audit reports. # Output only. Enrolled destination details for the organization, folder, or project.
+    "destinationDetails": [ # Output only. Cloud Storage buckets where you want to upload the audit reports.
+      { # Cloud Storage bucket where the audit report is uploaded to.
+        "gcsBucketUri": "A String", # URI for the Cloud Storage bucket, in the format `gs://{bucket_name}`.
+      },
+    ],
+    "name": "A String", # Identifier. Name of the enrollment, in one of the following formats: * `projects/{project}/locations/{location}/enrollments/{enrollment}` * `folders/{folder}/locations/{location}/enrollments/{enrollment}` * `organizations/{organization}/locations/{location}/enrollments/{enrollment}`
+  },
+  "enrollmentState": "A String", # Output only. Enrollment state of the organization, folder, or project.
+  "name": "A String", # Identifier. Name of the resource enrollment status, in one of the following formats: * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the folders and projects in an organization or folder, along with their enrollments.
+
+Args:
+  parent: string, Required. Parent organization or folder to list enrollment statuses for, in one of the following formats: * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}` (required)
+  pageSize: integer, Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
+  pageToken: string, Optional. A page token, received from a previous call, to retrieve the next page of 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 ListResourceEnrollmentStatuses.
+  "nextPageToken": "A String", # Output only. A token that you can send as the `page_token` in a subsequent request to retrieve the next page of results. If this field is empty, there are no subsequent pages.
+  "resourceEnrollmentStatuses": [ # Resources with their enrollment status.
+    { # An organization, folder, or project with its enrollment status.
+      "displayName": "A String", # Output only. Display name for the organization, folder, or project.
+      "enrolled": True or False, # Output only. Deprecated. Whether the organization, folder, or project is enrolled. Use `enrollment_state` instead.
+      "enrollment": { # Organization, folder, or project to enroll for audit reports. # Output only. Enrolled destination details for the organization, folder, or project.
+        "destinationDetails": [ # Output only. Cloud Storage buckets where you want to upload the audit reports.
+          { # Cloud Storage bucket where the audit report is uploaded to.
+            "gcsBucketUri": "A String", # URI for the Cloud Storage bucket, in the format `gs://{bucket_name}`.
+          },
+        ],
+        "name": "A String", # Identifier. Name of the enrollment, in one of the following formats: * `projects/{project}/locations/{location}/enrollments/{enrollment}` * `folders/{folder}/locations/{location}/enrollments/{enrollment}` * `organizations/{organization}/locations/{location}/enrollments/{enrollment}`
+      },
+      "enrollmentState": "A String", # Output only. Enrollment state of the organization, folder, or project.
+      "name": "A String", # Identifier. Name of the resource enrollment status, in one of the following formats: * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`
+    },
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.folders.locations.standards.controls.html b/docs/dyn/auditmanager_v1.folders.locations.standards.controls.html new file mode 100644 index 0000000000..62a7569024 --- /dev/null +++ b/docs/dyn/auditmanager_v1.folders.locations.standards.controls.html @@ -0,0 +1,144 @@ + + + +

Audit Manager API . folders . locations . standards . controls

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the controls that you must implement to become compliant to a regulatory standard.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the controls that you must implement to become compliant to a regulatory standard.
+
+Args:
+  parent: string, Required. Standard to list controls for, in one of the following formats: * `projects/{project}/locations/{location}/standards/{standard}` * `folders/{folder}/locations/{location}/standards/{standard}` * `organizations/{organization}/locations/{location}/standards/{standard}` (required)
+  pageSize: integer, Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
+  pageToken: string, Optional. A page token, received from a previous call, to retrieve the next page of 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 ListControls.
+  "controls": [ # Output only. Controls for a given regulatory standard.
+    { # A control.
+      "controlFamily": { # Regulatory family of the control. # Output only. Regulatory family of the control.
+        "displayName": "A String", # Display name of the regulatory control family.
+        "familyId": "A String", # ID of the regulatory control family. To find the list of supported control families, use the ListControls method and review the `control_family` field in the response.
+      },
+      "customerResponsibilityDescription": "A String", # Output only. A description of your responsibility for this control.
+      "customerResponsibilityImplementation": "A String", # Output only. A description of how you can implement your responsibility for this control.
+      "description": "A String", # Output only. Description of the control.
+      "displayName": "A String", # Output only. Display name of the control.
+      "family": "A String", # Output only. Category that the control belongs to.
+      "googleResponsibilityDescription": "A String", # Output only. A description of Google's responsibility for this control.
+      "googleResponsibilityImplementation": "A String", # Output only. A description of how Google implements its responsibility for this control.
+      "id": "A String", # Output only. Control identifier that's used to fetch the findings. The identifier is the same as the control report name.
+      "responsibilityType": "A String", # Output only. Who is responsible for implementing this control. Set to one of the following values: `GOOGLE`, `CUSTOMER`, or `SHARED`.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. A token that you can send as the `page_token` in a subsequent request to retrieve the next page of results. If this field is empty, there are no subsequent pages.
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.folders.locations.standards.html b/docs/dyn/auditmanager_v1.folders.locations.standards.html new file mode 100644 index 0000000000..a0c1952a0e --- /dev/null +++ b/docs/dyn/auditmanager_v1.folders.locations.standards.html @@ -0,0 +1,91 @@ + + + +

Audit Manager API . folders . locations . standards

+

Instance Methods

+

+ controls() +

+

Returns the controls Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.html b/docs/dyn/auditmanager_v1.html new file mode 100644 index 0000000000..022e3b826c --- /dev/null +++ b/docs/dyn/auditmanager_v1.html @@ -0,0 +1,121 @@ + + + +

Audit Manager API

+

Instance Methods

+

+ folders() +

+

Returns the folders Resource.

+ +

+ organizations() +

+

Returns the organizations Resource.

+ +

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request(callback=None)

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request(callback=None) +
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/auditmanager_v1.organizations.html b/docs/dyn/auditmanager_v1.organizations.html new file mode 100644 index 0000000000..b63446affa --- /dev/null +++ b/docs/dyn/auditmanager_v1.organizations.html @@ -0,0 +1,91 @@ + + + +

Audit Manager API . organizations

+

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/auditmanager_v1.organizations.locations.auditReports.html b/docs/dyn/auditmanager_v1.organizations.locations.auditReports.html new file mode 100644 index 0000000000..0761212e3d --- /dev/null +++ b/docs/dyn/auditmanager_v1.organizations.locations.auditReports.html @@ -0,0 +1,291 @@ + + + +

Audit Manager API . organizations . locations . auditReports

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Registers audit report generation requests. This method returns the operation identifier that you can use to track the report generation progress.

+

+ get(name, x__xgafv=None)

+

Gets the full metadata and findings for an audit report.

+

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

+

Lists the audit reports for the organization, folder, or project that you specify as the parent scope.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ generate(scope, body=None, x__xgafv=None) +
Registers audit report generation requests. This method returns the operation identifier that you can use to track the report generation progress.
+
+Args:
+  scope: string, Required. Organization, folder, or project that the audit applies to, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for GenerateAuditReport.
+  "complianceFramework": "A String", # Required. The framework that's used for the audit report. For example, `NIST_800_53`.
+  "complianceStandard": "A String", # Optional. Deprecated. Compliance standard for the audit report. Use the `compliance_framework` field instead.
+  "gcsUri": "A String", # URL for the Cloud Storage bucket where the report and evidence is uploaded. You must select a bucket that was provided during the enrollment process.
+  "reportFormat": "A String", # Required. Format for the audit report.
+  "validateOnly": True or False, # Optional. If `true`, only validates the request and does not generate the audit report. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase. Use this field for the following purposes: * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run dry-run mutations (e.g., `terraform plan`) without creating real resources or incurring costs. * **User Interface Validation**: Enable real-time form and permission validation in custom UIs before submitting requests. * **CI/CD & Automation**: Test your scripts, permissions, and parameters safely without triggering expensive Long-Running Operations (LROs) or consuming resource quotas.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the full metadata and findings for an audit report.
+
+Args:
+  name: string, Required. Name of the audit report, in one of the following formats: * `projects/{project}/locations/{location}/auditReports/{audit_report}` * `folders/{folder}/locations/{location}/auditReports/{audit_report}` * `organizations/{organization}/locations/{location}/auditReports/{audit_report}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An audit report.
+  "complianceFramework": "A String", # Output only. Compliance framework to use for the audit report. For example, `CIS_GCP_FOUNDATIONS_V1_2_0`.
+  "complianceStandard": "A String", # Output only. Deprecated. Compliance standard to be audited against. Use the `compliance_framework` field instead.
+  "controlDetails": [ # Output only. Overall status of the controls.
+    { # Evaluation details for a control.
+      "complianceState": "A String", # Output only. Overall status of the findings for the control.
+      "control": { # A control. # Control that the findings are being reported for.
+        "controlFamily": { # Regulatory family of the control. # Output only. Regulatory family of the control.
+          "displayName": "A String", # Display name of the regulatory control family.
+          "familyId": "A String", # ID of the regulatory control family. To find the list of supported control families, use the ListControls method and review the `control_family` field in the response.
+        },
+        "customerResponsibilityDescription": "A String", # Output only. A description of your responsibility for this control.
+        "customerResponsibilityImplementation": "A String", # Output only. A description of how you can implement your responsibility for this control.
+        "description": "A String", # Output only. Description of the control.
+        "displayName": "A String", # Output only. Display name of the control.
+        "family": "A String", # Output only. Category that the control belongs to.
+        "googleResponsibilityDescription": "A String", # Output only. A description of Google's responsibility for this control.
+        "googleResponsibilityImplementation": "A String", # Output only. A description of how Google implements its responsibility for this control.
+        "id": "A String", # Output only. Control identifier that's used to fetch the findings. The identifier is the same as the control report name.
+        "responsibilityType": "A String", # Output only. Who is responsible for implementing this control. Set to one of the following values: `GOOGLE`, `CUSTOMER`, or `SHARED`.
+      },
+      "controlReportSummary": { # Additional information about the number of checks that were made during an audit operation. # A control report summary that provides a high-level overview of the compliance controls and the assessment status.
+        "compliantCount": 42, # Number of compliant checks.
+        "errorCount": 42, # Number of checks that can't be performed due to errors.
+        "manualReviewNeededCount": 42, # Number of checks that require a manual review.
+        "totalCount": 42, # Total number of evaluated checks.
+        "violationCount": 42, # Number of checks with violations.
+      },
+    },
+  ],
+  "createTime": "A String", # Output only. Creation time of the audit report.
+  "destinationDetails": { # Cloud Storage bucket where the audit report is uploaded to. # Output only. Cloud Storage bucket where the audit report is uploaded to.
+    "gcsBucketUri": "A String", # URI for the Cloud Storage bucket, in the format `gs://{bucket_name}`.
+  },
+  "name": "A String", # Identifier. Name of the audit report, in one of the following formats: * `projects/{project}/locations/{location}/auditReports/{audit_report}` * `folders/{folder}/locations/{location}/auditReports/{audit_report}` * `organizations/{organization}/locations/{location}/auditReports/{audit_report}`
+  "operationId": "A String", # Output only. Client operation ID for the audit report.
+  "reportGenerationState": "A String", # Output only. State of audit report generation.
+  "reportSummary": { # Additional information about the number of checks that were made during an audit operation. # Output only. Report summary that includes information about compliance and violation counts.
+    "compliantCount": 42, # Number of compliant checks.
+    "errorCount": 42, # Number of checks that can't be performed due to errors.
+    "manualReviewNeededCount": 42, # Number of checks that require a manual review.
+    "totalCount": 42, # Total number of evaluated checks.
+    "violationCount": 42, # Number of checks with violations.
+  },
+  "scope": "A String", # Output only. Organization, folder, or project that the report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
+  "scopeId": "A String", # Output only. Project number, folder ID, or organization ID that the audit report was generated for.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the audit reports for the organization, folder, or project that you specify as the parent scope.
+
+Args:
+  parent: string, Required. Parent organization, folder, or project to list reports for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}` (required)
+  pageSize: integer, Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
+  pageToken: string, Optional. A page token, received from a previous call, to retrieve the next page of 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 ListAuditReports.
+  "auditReports": [ # Output only. Audit reports.
+    { # An audit report.
+      "complianceFramework": "A String", # Output only. Compliance framework to use for the audit report. For example, `CIS_GCP_FOUNDATIONS_V1_2_0`.
+      "complianceStandard": "A String", # Output only. Deprecated. Compliance standard to be audited against. Use the `compliance_framework` field instead.
+      "controlDetails": [ # Output only. Overall status of the controls.
+        { # Evaluation details for a control.
+          "complianceState": "A String", # Output only. Overall status of the findings for the control.
+          "control": { # A control. # Control that the findings are being reported for.
+            "controlFamily": { # Regulatory family of the control. # Output only. Regulatory family of the control.
+              "displayName": "A String", # Display name of the regulatory control family.
+              "familyId": "A String", # ID of the regulatory control family. To find the list of supported control families, use the ListControls method and review the `control_family` field in the response.
+            },
+            "customerResponsibilityDescription": "A String", # Output only. A description of your responsibility for this control.
+            "customerResponsibilityImplementation": "A String", # Output only. A description of how you can implement your responsibility for this control.
+            "description": "A String", # Output only. Description of the control.
+            "displayName": "A String", # Output only. Display name of the control.
+            "family": "A String", # Output only. Category that the control belongs to.
+            "googleResponsibilityDescription": "A String", # Output only. A description of Google's responsibility for this control.
+            "googleResponsibilityImplementation": "A String", # Output only. A description of how Google implements its responsibility for this control.
+            "id": "A String", # Output only. Control identifier that's used to fetch the findings. The identifier is the same as the control report name.
+            "responsibilityType": "A String", # Output only. Who is responsible for implementing this control. Set to one of the following values: `GOOGLE`, `CUSTOMER`, or `SHARED`.
+          },
+          "controlReportSummary": { # Additional information about the number of checks that were made during an audit operation. # A control report summary that provides a high-level overview of the compliance controls and the assessment status.
+            "compliantCount": 42, # Number of compliant checks.
+            "errorCount": 42, # Number of checks that can't be performed due to errors.
+            "manualReviewNeededCount": 42, # Number of checks that require a manual review.
+            "totalCount": 42, # Total number of evaluated checks.
+            "violationCount": 42, # Number of checks with violations.
+          },
+        },
+      ],
+      "createTime": "A String", # Output only. Creation time of the audit report.
+      "destinationDetails": { # Cloud Storage bucket where the audit report is uploaded to. # Output only. Cloud Storage bucket where the audit report is uploaded to.
+        "gcsBucketUri": "A String", # URI for the Cloud Storage bucket, in the format `gs://{bucket_name}`.
+      },
+      "name": "A String", # Identifier. Name of the audit report, in one of the following formats: * `projects/{project}/locations/{location}/auditReports/{audit_report}` * `folders/{folder}/locations/{location}/auditReports/{audit_report}` * `organizations/{organization}/locations/{location}/auditReports/{audit_report}`
+      "operationId": "A String", # Output only. Client operation ID for the audit report.
+      "reportGenerationState": "A String", # Output only. State of audit report generation.
+      "reportSummary": { # Additional information about the number of checks that were made during an audit operation. # Output only. Report summary that includes information about compliance and violation counts.
+        "compliantCount": 42, # Number of compliant checks.
+        "errorCount": 42, # Number of checks that can't be performed due to errors.
+        "manualReviewNeededCount": 42, # Number of checks that require a manual review.
+        "totalCount": 42, # Total number of evaluated checks.
+        "violationCount": 42, # Number of checks with violations.
+      },
+      "scope": "A String", # Output only. Organization, folder, or project that the report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
+      "scopeId": "A String", # Output only. Project number, folder ID, or organization ID that the audit report was generated for.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. A token that you can send as the `page_token` in a subsequent request to retrieve the next page of results. If this field is empty, there are no subsequent pages.
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.organizations.locations.auditScopeReports.html b/docs/dyn/auditmanager_v1.organizations.locations.auditScopeReports.html new file mode 100644 index 0000000000..b458463dcd --- /dev/null +++ b/docs/dyn/auditmanager_v1.organizations.locations.auditScopeReports.html @@ -0,0 +1,119 @@ + + + +

Audit Manager API . organizations . locations . auditScopeReports

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Generates an audit scope report for the given standard. The report includes the following: * The technical attributes and constraints that Audit Manager uses to verify your compliance with a framework. * A list of Google Cloud services and resources that are within the scope of the framework.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ generate(scope, body=None, x__xgafv=None) +
Generates an audit scope report for the given standard. The report includes the following: * The technical attributes and constraints that Audit Manager uses to verify your compliance with a framework. * A list of Google Cloud services and resources that are within the scope of the framework.
+
+Args:
+  scope: string, Required. Project or folder that the audit scope report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for GenerateAuditScopeReport.
+  "complianceFramework": "A String", # Required. Framework (set of controls) that the audit scope report is generated against. For example, `NIST_800_53`.
+  "complianceStandard": "A String", # Optional. Deprecated. The standard (industry or regulatory requirements) that the audit scope report is run against. Use the `compliance_framework` field instead.
+  "reportFormat": "A String", # Required. Format for the audit scope report.
+  "validateOnly": True or False, # Optional. If `true`, only validates the request and does not generate the audit scope report. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase. Use this field for the following purposes: * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run dry-run mutations (e.g., `terraform plan`) without creating real resources or incurring costs. * **User Interface Validation**: Enable real-time form and permission validation in custom UIs before submitting requests. * **CI/CD & Automation**: Test your scripts, permissions, and parameters safely without consuming resource quotas.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Audit scope report.
+  "name": "A String", # Identifier. Name for the audit scope report, in one of the following formats: * `projects/{project}/locations/{location}/auditScopeReports/{audit_scope_report}` * `folders/{folder}/locations/{location}/auditScopeReports/{audit_scope_report}` * `organizations/{organization}/locations/{location}/auditScopeReports/{audit_scope_report}`
+  "scopeReportContents": "A String", # Audit scope report content in byte format.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.organizations.locations.html b/docs/dyn/auditmanager_v1.organizations.locations.html new file mode 100644 index 0000000000..e338d34fd8 --- /dev/null +++ b/docs/dyn/auditmanager_v1.organizations.locations.html @@ -0,0 +1,160 @@ + + + +

Audit Manager API . organizations . locations

+

Instance Methods

+

+ auditReports() +

+

Returns the auditReports Resource.

+ +

+ auditScopeReports() +

+

Returns the auditScopeReports Resource.

+ +

+ operationDetails() +

+

Returns the operationDetails Resource.

+ +

+ operationIds() +

+

Returns the operationIds Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ resourceEnrollmentStatuses() +

+

Returns the resourceEnrollmentStatuses Resource.

+ +

+ standards() +

+

Returns the standards Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ enrollResource(scope, body=None, x__xgafv=None)

+

Adds your project, folder, or organization to Audit Manager. This method creates the Audit Manager service agent in your workload and grants required permissions to the service agent. If you make this request on a workload that's already enrolled, then this method overrides the existing set of destinations.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ enrollResource(scope, body=None, x__xgafv=None) +
Adds your project, folder, or organization to Audit Manager. This method creates the Audit Manager service agent in your workload and grants required permissions to the service agent. If you make this request on a workload that's already enrolled, then this method overrides the existing set of destinations.
+
+Args:
+  scope: string, Required. Organization, folder, or project to enroll in Audit Manager, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for EnrollResource.
+  "destinations": [ # Required. Cloud Storage buckets that you can upload your audit reports to during the audit process. When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.
+    { # Details about the bucket where you want to upload the audit report.
+      "eligibleGcsBucket": "A String", # The location of the Cloud Storage bucket where you want to upload the audit report and evidence during the GenerateAuditReport API call.
+    },
+  ],
+  "validateOnly": True or False, # Optional. If `true`, only validates the request and does not enroll the resource. This executes standard request validation (such as schema, IAM, and destination checks) and skips the apply phase. Use this field for the following purposes: * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run dry-run mutations (e.g., `terraform plan`) without creating real resources or incurring costs. * **User Interface Validation**: Enable real-time form and permission validation in custom UIs before submitting requests. * **CI/CD & Automation**: Test your scripts, permissions, and parameters safely without consuming resource quotas.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Organization, folder, or project to enroll for audit reports.
+  "destinationDetails": [ # Output only. Cloud Storage buckets where you want to upload the audit reports.
+    { # Cloud Storage bucket where the audit report is uploaded to.
+      "gcsBucketUri": "A String", # URI for the Cloud Storage bucket, in the format `gs://{bucket_name}`.
+    },
+  ],
+  "name": "A String", # Identifier. Name of the enrollment, in one of the following formats: * `projects/{project}/locations/{location}/enrollments/{enrollment}` * `folders/{folder}/locations/{location}/enrollments/{enrollment}` * `organizations/{organization}/locations/{location}/enrollments/{enrollment}`
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.organizations.locations.operationDetails.html b/docs/dyn/auditmanager_v1.organizations.locations.operationDetails.html new file mode 100644 index 0000000000..a99adc43e7 --- /dev/null +++ b/docs/dyn/auditmanager_v1.organizations.locations.operationDetails.html @@ -0,0 +1,124 @@ + + + +

Audit Manager API . organizations . locations . operationDetails

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details about the long-running operation to generate audit reports.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details about the long-running operation to generate audit reports.
+
+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/auditmanager_v1.organizations.locations.operationIds.html b/docs/dyn/auditmanager_v1.organizations.locations.operationIds.html new file mode 100644 index 0000000000..c69ef119cf --- /dev/null +++ b/docs/dyn/auditmanager_v1.organizations.locations.operationIds.html @@ -0,0 +1,124 @@ + + + +

Audit Manager API . organizations . locations . operationIds

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details about the long-running operation to generate audit reports.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details about the long-running operation to generate audit reports.
+
+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/auditmanager_v1.organizations.locations.operations.html b/docs/dyn/auditmanager_v1.organizations.locations.operations.html new file mode 100644 index 0000000000..93979d5e20 --- /dev/null +++ b/docs/dyn/auditmanager_v1.organizations.locations.operations.html @@ -0,0 +1,239 @@ + + + +

Audit Manager API . organizations . locations . operations

+

Instance Methods

+

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

+

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

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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

+

+ get(name, x__xgafv=None)

+

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

+

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

+

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

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

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

Audit Manager API . organizations . locations . resourceEnrollmentStatuses

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a resource and its enrollment status.

+

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

+

Lists all the folders and projects in an organization or folder, along with their enrollments.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a resource and its enrollment status.
+
+Args:
+  name: string, Required. Name of the resource enrollment status, in one of the following formats: * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An organization, folder, or project with its enrollment status.
+  "displayName": "A String", # Output only. Display name for the organization, folder, or project.
+  "enrolled": True or False, # Output only. Deprecated. Whether the organization, folder, or project is enrolled. Use `enrollment_state` instead.
+  "enrollment": { # Organization, folder, or project to enroll for audit reports. # Output only. Enrolled destination details for the organization, folder, or project.
+    "destinationDetails": [ # Output only. Cloud Storage buckets where you want to upload the audit reports.
+      { # Cloud Storage bucket where the audit report is uploaded to.
+        "gcsBucketUri": "A String", # URI for the Cloud Storage bucket, in the format `gs://{bucket_name}`.
+      },
+    ],
+    "name": "A String", # Identifier. Name of the enrollment, in one of the following formats: * `projects/{project}/locations/{location}/enrollments/{enrollment}` * `folders/{folder}/locations/{location}/enrollments/{enrollment}` * `organizations/{organization}/locations/{location}/enrollments/{enrollment}`
+  },
+  "enrollmentState": "A String", # Output only. Enrollment state of the organization, folder, or project.
+  "name": "A String", # Identifier. Name of the resource enrollment status, in one of the following formats: * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the folders and projects in an organization or folder, along with their enrollments.
+
+Args:
+  parent: string, Required. Parent organization or folder to list enrollment statuses for, in one of the following formats: * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}` (required)
+  pageSize: integer, Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
+  pageToken: string, Optional. A page token, received from a previous call, to retrieve the next page of 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 ListResourceEnrollmentStatuses.
+  "nextPageToken": "A String", # Output only. A token that you can send as the `page_token` in a subsequent request to retrieve the next page of results. If this field is empty, there are no subsequent pages.
+  "resourceEnrollmentStatuses": [ # Resources with their enrollment status.
+    { # An organization, folder, or project with its enrollment status.
+      "displayName": "A String", # Output only. Display name for the organization, folder, or project.
+      "enrolled": True or False, # Output only. Deprecated. Whether the organization, folder, or project is enrolled. Use `enrollment_state` instead.
+      "enrollment": { # Organization, folder, or project to enroll for audit reports. # Output only. Enrolled destination details for the organization, folder, or project.
+        "destinationDetails": [ # Output only. Cloud Storage buckets where you want to upload the audit reports.
+          { # Cloud Storage bucket where the audit report is uploaded to.
+            "gcsBucketUri": "A String", # URI for the Cloud Storage bucket, in the format `gs://{bucket_name}`.
+          },
+        ],
+        "name": "A String", # Identifier. Name of the enrollment, in one of the following formats: * `projects/{project}/locations/{location}/enrollments/{enrollment}` * `folders/{folder}/locations/{location}/enrollments/{enrollment}` * `organizations/{organization}/locations/{location}/enrollments/{enrollment}`
+      },
+      "enrollmentState": "A String", # Output only. Enrollment state of the organization, folder, or project.
+      "name": "A String", # Identifier. Name of the resource enrollment status, in one of the following formats: * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`
+    },
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.organizations.locations.standards.controls.html b/docs/dyn/auditmanager_v1.organizations.locations.standards.controls.html new file mode 100644 index 0000000000..a0d8c0cdf7 --- /dev/null +++ b/docs/dyn/auditmanager_v1.organizations.locations.standards.controls.html @@ -0,0 +1,144 @@ + + + +

Audit Manager API . organizations . locations . standards . controls

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the controls that you must implement to become compliant to a regulatory standard.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the controls that you must implement to become compliant to a regulatory standard.
+
+Args:
+  parent: string, Required. Standard to list controls for, in one of the following formats: * `projects/{project}/locations/{location}/standards/{standard}` * `folders/{folder}/locations/{location}/standards/{standard}` * `organizations/{organization}/locations/{location}/standards/{standard}` (required)
+  pageSize: integer, Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
+  pageToken: string, Optional. A page token, received from a previous call, to retrieve the next page of 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 ListControls.
+  "controls": [ # Output only. Controls for a given regulatory standard.
+    { # A control.
+      "controlFamily": { # Regulatory family of the control. # Output only. Regulatory family of the control.
+        "displayName": "A String", # Display name of the regulatory control family.
+        "familyId": "A String", # ID of the regulatory control family. To find the list of supported control families, use the ListControls method and review the `control_family` field in the response.
+      },
+      "customerResponsibilityDescription": "A String", # Output only. A description of your responsibility for this control.
+      "customerResponsibilityImplementation": "A String", # Output only. A description of how you can implement your responsibility for this control.
+      "description": "A String", # Output only. Description of the control.
+      "displayName": "A String", # Output only. Display name of the control.
+      "family": "A String", # Output only. Category that the control belongs to.
+      "googleResponsibilityDescription": "A String", # Output only. A description of Google's responsibility for this control.
+      "googleResponsibilityImplementation": "A String", # Output only. A description of how Google implements its responsibility for this control.
+      "id": "A String", # Output only. Control identifier that's used to fetch the findings. The identifier is the same as the control report name.
+      "responsibilityType": "A String", # Output only. Who is responsible for implementing this control. Set to one of the following values: `GOOGLE`, `CUSTOMER`, or `SHARED`.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. A token that you can send as the `page_token` in a subsequent request to retrieve the next page of results. If this field is empty, there are no subsequent pages.
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.organizations.locations.standards.html b/docs/dyn/auditmanager_v1.organizations.locations.standards.html new file mode 100644 index 0000000000..c86102d101 --- /dev/null +++ b/docs/dyn/auditmanager_v1.organizations.locations.standards.html @@ -0,0 +1,91 @@ + + + +

Audit Manager API . organizations . locations . standards

+

Instance Methods

+

+ controls() +

+

Returns the controls Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.projects.html b/docs/dyn/auditmanager_v1.projects.html new file mode 100644 index 0000000000..f406004b15 --- /dev/null +++ b/docs/dyn/auditmanager_v1.projects.html @@ -0,0 +1,91 @@ + + + +

Audit Manager 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/auditmanager_v1.projects.locations.auditReports.html b/docs/dyn/auditmanager_v1.projects.locations.auditReports.html new file mode 100644 index 0000000000..243ff0427a --- /dev/null +++ b/docs/dyn/auditmanager_v1.projects.locations.auditReports.html @@ -0,0 +1,291 @@ + + + +

Audit Manager API . projects . locations . auditReports

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Registers audit report generation requests. This method returns the operation identifier that you can use to track the report generation progress.

+

+ get(name, x__xgafv=None)

+

Gets the full metadata and findings for an audit report.

+

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

+

Lists the audit reports for the organization, folder, or project that you specify as the parent scope.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ generate(scope, body=None, x__xgafv=None) +
Registers audit report generation requests. This method returns the operation identifier that you can use to track the report generation progress.
+
+Args:
+  scope: string, Required. Organization, folder, or project that the audit applies to, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for GenerateAuditReport.
+  "complianceFramework": "A String", # Required. The framework that's used for the audit report. For example, `NIST_800_53`.
+  "complianceStandard": "A String", # Optional. Deprecated. Compliance standard for the audit report. Use the `compliance_framework` field instead.
+  "gcsUri": "A String", # URL for the Cloud Storage bucket where the report and evidence is uploaded. You must select a bucket that was provided during the enrollment process.
+  "reportFormat": "A String", # Required. Format for the audit report.
+  "validateOnly": True or False, # Optional. If `true`, only validates the request and does not generate the audit report. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase. Use this field for the following purposes: * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run dry-run mutations (e.g., `terraform plan`) without creating real resources or incurring costs. * **User Interface Validation**: Enable real-time form and permission validation in custom UIs before submitting requests. * **CI/CD & Automation**: Test your scripts, permissions, and parameters safely without triggering expensive Long-Running Operations (LROs) or consuming resource quotas.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the full metadata and findings for an audit report.
+
+Args:
+  name: string, Required. Name of the audit report, in one of the following formats: * `projects/{project}/locations/{location}/auditReports/{audit_report}` * `folders/{folder}/locations/{location}/auditReports/{audit_report}` * `organizations/{organization}/locations/{location}/auditReports/{audit_report}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An audit report.
+  "complianceFramework": "A String", # Output only. Compliance framework to use for the audit report. For example, `CIS_GCP_FOUNDATIONS_V1_2_0`.
+  "complianceStandard": "A String", # Output only. Deprecated. Compliance standard to be audited against. Use the `compliance_framework` field instead.
+  "controlDetails": [ # Output only. Overall status of the controls.
+    { # Evaluation details for a control.
+      "complianceState": "A String", # Output only. Overall status of the findings for the control.
+      "control": { # A control. # Control that the findings are being reported for.
+        "controlFamily": { # Regulatory family of the control. # Output only. Regulatory family of the control.
+          "displayName": "A String", # Display name of the regulatory control family.
+          "familyId": "A String", # ID of the regulatory control family. To find the list of supported control families, use the ListControls method and review the `control_family` field in the response.
+        },
+        "customerResponsibilityDescription": "A String", # Output only. A description of your responsibility for this control.
+        "customerResponsibilityImplementation": "A String", # Output only. A description of how you can implement your responsibility for this control.
+        "description": "A String", # Output only. Description of the control.
+        "displayName": "A String", # Output only. Display name of the control.
+        "family": "A String", # Output only. Category that the control belongs to.
+        "googleResponsibilityDescription": "A String", # Output only. A description of Google's responsibility for this control.
+        "googleResponsibilityImplementation": "A String", # Output only. A description of how Google implements its responsibility for this control.
+        "id": "A String", # Output only. Control identifier that's used to fetch the findings. The identifier is the same as the control report name.
+        "responsibilityType": "A String", # Output only. Who is responsible for implementing this control. Set to one of the following values: `GOOGLE`, `CUSTOMER`, or `SHARED`.
+      },
+      "controlReportSummary": { # Additional information about the number of checks that were made during an audit operation. # A control report summary that provides a high-level overview of the compliance controls and the assessment status.
+        "compliantCount": 42, # Number of compliant checks.
+        "errorCount": 42, # Number of checks that can't be performed due to errors.
+        "manualReviewNeededCount": 42, # Number of checks that require a manual review.
+        "totalCount": 42, # Total number of evaluated checks.
+        "violationCount": 42, # Number of checks with violations.
+      },
+    },
+  ],
+  "createTime": "A String", # Output only. Creation time of the audit report.
+  "destinationDetails": { # Cloud Storage bucket where the audit report is uploaded to. # Output only. Cloud Storage bucket where the audit report is uploaded to.
+    "gcsBucketUri": "A String", # URI for the Cloud Storage bucket, in the format `gs://{bucket_name}`.
+  },
+  "name": "A String", # Identifier. Name of the audit report, in one of the following formats: * `projects/{project}/locations/{location}/auditReports/{audit_report}` * `folders/{folder}/locations/{location}/auditReports/{audit_report}` * `organizations/{organization}/locations/{location}/auditReports/{audit_report}`
+  "operationId": "A String", # Output only. Client operation ID for the audit report.
+  "reportGenerationState": "A String", # Output only. State of audit report generation.
+  "reportSummary": { # Additional information about the number of checks that were made during an audit operation. # Output only. Report summary that includes information about compliance and violation counts.
+    "compliantCount": 42, # Number of compliant checks.
+    "errorCount": 42, # Number of checks that can't be performed due to errors.
+    "manualReviewNeededCount": 42, # Number of checks that require a manual review.
+    "totalCount": 42, # Total number of evaluated checks.
+    "violationCount": 42, # Number of checks with violations.
+  },
+  "scope": "A String", # Output only. Organization, folder, or project that the report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
+  "scopeId": "A String", # Output only. Project number, folder ID, or organization ID that the audit report was generated for.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the audit reports for the organization, folder, or project that you specify as the parent scope.
+
+Args:
+  parent: string, Required. Parent organization, folder, or project to list reports for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}` (required)
+  pageSize: integer, Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
+  pageToken: string, Optional. A page token, received from a previous call, to retrieve the next page of 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 ListAuditReports.
+  "auditReports": [ # Output only. Audit reports.
+    { # An audit report.
+      "complianceFramework": "A String", # Output only. Compliance framework to use for the audit report. For example, `CIS_GCP_FOUNDATIONS_V1_2_0`.
+      "complianceStandard": "A String", # Output only. Deprecated. Compliance standard to be audited against. Use the `compliance_framework` field instead.
+      "controlDetails": [ # Output only. Overall status of the controls.
+        { # Evaluation details for a control.
+          "complianceState": "A String", # Output only. Overall status of the findings for the control.
+          "control": { # A control. # Control that the findings are being reported for.
+            "controlFamily": { # Regulatory family of the control. # Output only. Regulatory family of the control.
+              "displayName": "A String", # Display name of the regulatory control family.
+              "familyId": "A String", # ID of the regulatory control family. To find the list of supported control families, use the ListControls method and review the `control_family` field in the response.
+            },
+            "customerResponsibilityDescription": "A String", # Output only. A description of your responsibility for this control.
+            "customerResponsibilityImplementation": "A String", # Output only. A description of how you can implement your responsibility for this control.
+            "description": "A String", # Output only. Description of the control.
+            "displayName": "A String", # Output only. Display name of the control.
+            "family": "A String", # Output only. Category that the control belongs to.
+            "googleResponsibilityDescription": "A String", # Output only. A description of Google's responsibility for this control.
+            "googleResponsibilityImplementation": "A String", # Output only. A description of how Google implements its responsibility for this control.
+            "id": "A String", # Output only. Control identifier that's used to fetch the findings. The identifier is the same as the control report name.
+            "responsibilityType": "A String", # Output only. Who is responsible for implementing this control. Set to one of the following values: `GOOGLE`, `CUSTOMER`, or `SHARED`.
+          },
+          "controlReportSummary": { # Additional information about the number of checks that were made during an audit operation. # A control report summary that provides a high-level overview of the compliance controls and the assessment status.
+            "compliantCount": 42, # Number of compliant checks.
+            "errorCount": 42, # Number of checks that can't be performed due to errors.
+            "manualReviewNeededCount": 42, # Number of checks that require a manual review.
+            "totalCount": 42, # Total number of evaluated checks.
+            "violationCount": 42, # Number of checks with violations.
+          },
+        },
+      ],
+      "createTime": "A String", # Output only. Creation time of the audit report.
+      "destinationDetails": { # Cloud Storage bucket where the audit report is uploaded to. # Output only. Cloud Storage bucket where the audit report is uploaded to.
+        "gcsBucketUri": "A String", # URI for the Cloud Storage bucket, in the format `gs://{bucket_name}`.
+      },
+      "name": "A String", # Identifier. Name of the audit report, in one of the following formats: * `projects/{project}/locations/{location}/auditReports/{audit_report}` * `folders/{folder}/locations/{location}/auditReports/{audit_report}` * `organizations/{organization}/locations/{location}/auditReports/{audit_report}`
+      "operationId": "A String", # Output only. Client operation ID for the audit report.
+      "reportGenerationState": "A String", # Output only. State of audit report generation.
+      "reportSummary": { # Additional information about the number of checks that were made during an audit operation. # Output only. Report summary that includes information about compliance and violation counts.
+        "compliantCount": 42, # Number of compliant checks.
+        "errorCount": 42, # Number of checks that can't be performed due to errors.
+        "manualReviewNeededCount": 42, # Number of checks that require a manual review.
+        "totalCount": 42, # Total number of evaluated checks.
+        "violationCount": 42, # Number of checks with violations.
+      },
+      "scope": "A String", # Output only. Organization, folder, or project that the report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
+      "scopeId": "A String", # Output only. Project number, folder ID, or organization ID that the audit report was generated for.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. A token that you can send as the `page_token` in a subsequent request to retrieve the next page of results. If this field is empty, there are no subsequent pages.
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.projects.locations.auditScopeReports.html b/docs/dyn/auditmanager_v1.projects.locations.auditScopeReports.html new file mode 100644 index 0000000000..9a1f160f8c --- /dev/null +++ b/docs/dyn/auditmanager_v1.projects.locations.auditScopeReports.html @@ -0,0 +1,119 @@ + + + +

Audit Manager API . projects . locations . auditScopeReports

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Generates an audit scope report for the given standard. The report includes the following: * The technical attributes and constraints that Audit Manager uses to verify your compliance with a framework. * A list of Google Cloud services and resources that are within the scope of the framework.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ generate(scope, body=None, x__xgafv=None) +
Generates an audit scope report for the given standard. The report includes the following: * The technical attributes and constraints that Audit Manager uses to verify your compliance with a framework. * A list of Google Cloud services and resources that are within the scope of the framework.
+
+Args:
+  scope: string, Required. Project or folder that the audit scope report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for GenerateAuditScopeReport.
+  "complianceFramework": "A String", # Required. Framework (set of controls) that the audit scope report is generated against. For example, `NIST_800_53`.
+  "complianceStandard": "A String", # Optional. Deprecated. The standard (industry or regulatory requirements) that the audit scope report is run against. Use the `compliance_framework` field instead.
+  "reportFormat": "A String", # Required. Format for the audit scope report.
+  "validateOnly": True or False, # Optional. If `true`, only validates the request and does not generate the audit scope report. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase. Use this field for the following purposes: * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run dry-run mutations (e.g., `terraform plan`) without creating real resources or incurring costs. * **User Interface Validation**: Enable real-time form and permission validation in custom UIs before submitting requests. * **CI/CD & Automation**: Test your scripts, permissions, and parameters safely without consuming resource quotas.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Audit scope report.
+  "name": "A String", # Identifier. Name for the audit scope report, in one of the following formats: * `projects/{project}/locations/{location}/auditScopeReports/{audit_scope_report}` * `folders/{folder}/locations/{location}/auditScopeReports/{audit_scope_report}` * `organizations/{organization}/locations/{location}/auditScopeReports/{audit_scope_report}`
+  "scopeReportContents": "A String", # Audit scope report content in byte format.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.projects.locations.html b/docs/dyn/auditmanager_v1.projects.locations.html new file mode 100644 index 0000000000..7dcf5d0b49 --- /dev/null +++ b/docs/dyn/auditmanager_v1.projects.locations.html @@ -0,0 +1,246 @@ + + + +

Audit Manager API . projects . locations

+

Instance Methods

+

+ auditReports() +

+

Returns the auditReports Resource.

+ +

+ auditScopeReports() +

+

Returns the auditScopeReports Resource.

+ +

+ operationDetails() +

+

Returns the operationDetails Resource.

+ +

+ operationIds() +

+

Returns the operationIds Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ resourceEnrollmentStatuses() +

+

Returns the resourceEnrollmentStatuses Resource.

+ +

+ standards() +

+

Returns the standards Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ enrollResource(scope, body=None, x__xgafv=None)

+

Adds your project, folder, or organization to Audit Manager. This method creates the Audit Manager service agent in your workload and grants required permissions to the service agent. If you make this request on a workload that's already enrolled, then this method overrides the existing set of destinations.

+

+ 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(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ enrollResource(scope, body=None, x__xgafv=None) +
Adds your project, folder, or organization to Audit Manager. This method creates the Audit Manager service agent in your workload and grants required permissions to the service agent. If you make this request on a workload that's already enrolled, then this method overrides the existing set of destinations.
+
+Args:
+  scope: string, Required. Organization, folder, or project to enroll in Audit Manager, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for EnrollResource.
+  "destinations": [ # Required. Cloud Storage buckets that you can upload your audit reports to during the audit process. When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.
+    { # Details about the bucket where you want to upload the audit report.
+      "eligibleGcsBucket": "A String", # The location of the Cloud Storage bucket where you want to upload the audit report and evidence during the GenerateAuditReport API call.
+    },
+  ],
+  "validateOnly": True or False, # Optional. If `true`, only validates the request and does not enroll the resource. This executes standard request validation (such as schema, IAM, and destination checks) and skips the apply phase. Use this field for the following purposes: * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run dry-run mutations (e.g., `terraform plan`) without creating real resources or incurring costs. * **User Interface Validation**: Enable real-time form and permission validation in custom UIs before submitting requests. * **CI/CD & Automation**: Test your scripts, permissions, and parameters safely without consuming resource quotas.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Organization, folder, or project to enroll for audit reports.
+  "destinationDetails": [ # Output only. Cloud Storage buckets where you want to upload the audit reports.
+    { # Cloud Storage bucket where the audit report is uploaded to.
+      "gcsBucketUri": "A String", # URI for the Cloud Storage bucket, in the format `gs://{bucket_name}`.
+    },
+  ],
+  "name": "A String", # Identifier. Name of the enrollment, in one of the following formats: * `projects/{project}/locations/{location}/enrollments/{enrollment}` * `folders/{folder}/locations/{location}/enrollments/{enrollment}` * `organizations/{organization}/locations/{location}/enrollments/{enrollment}`
+}
+
+ +
+ 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(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.projects.locations.operationDetails.html b/docs/dyn/auditmanager_v1.projects.locations.operationDetails.html new file mode 100644 index 0000000000..60c7a663f3 --- /dev/null +++ b/docs/dyn/auditmanager_v1.projects.locations.operationDetails.html @@ -0,0 +1,124 @@ + + + +

Audit Manager API . projects . locations . operationDetails

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details about the long-running operation to generate audit reports.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details about the long-running operation to generate audit reports.
+
+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/auditmanager_v1.projects.locations.operationIds.html b/docs/dyn/auditmanager_v1.projects.locations.operationIds.html new file mode 100644 index 0000000000..fb8a402ab0 --- /dev/null +++ b/docs/dyn/auditmanager_v1.projects.locations.operationIds.html @@ -0,0 +1,124 @@ + + + +

Audit Manager API . projects . locations . operationIds

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details about the long-running operation to generate audit reports.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details about the long-running operation to generate audit reports.
+
+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/auditmanager_v1.projects.locations.operations.html b/docs/dyn/auditmanager_v1.projects.locations.operations.html new file mode 100644 index 0000000000..1c7f41ef52 --- /dev/null +++ b/docs/dyn/auditmanager_v1.projects.locations.operations.html @@ -0,0 +1,239 @@ + + + +

Audit Manager API . projects . locations . operations

+

Instance Methods

+

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

+

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

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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

+

+ get(name, x__xgafv=None)

+

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

+

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

+

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

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

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

Audit Manager API . projects . locations . resourceEnrollmentStatuses

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a resource and its enrollment status.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a resource and its enrollment status.
+
+Args:
+  name: string, Required. Name of the resource enrollment status, in one of the following formats: * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An organization, folder, or project with its enrollment status.
+  "displayName": "A String", # Output only. Display name for the organization, folder, or project.
+  "enrolled": True or False, # Output only. Deprecated. Whether the organization, folder, or project is enrolled. Use `enrollment_state` instead.
+  "enrollment": { # Organization, folder, or project to enroll for audit reports. # Output only. Enrolled destination details for the organization, folder, or project.
+    "destinationDetails": [ # Output only. Cloud Storage buckets where you want to upload the audit reports.
+      { # Cloud Storage bucket where the audit report is uploaded to.
+        "gcsBucketUri": "A String", # URI for the Cloud Storage bucket, in the format `gs://{bucket_name}`.
+      },
+    ],
+    "name": "A String", # Identifier. Name of the enrollment, in one of the following formats: * `projects/{project}/locations/{location}/enrollments/{enrollment}` * `folders/{folder}/locations/{location}/enrollments/{enrollment}` * `organizations/{organization}/locations/{location}/enrollments/{enrollment}`
+  },
+  "enrollmentState": "A String", # Output only. Enrollment state of the organization, folder, or project.
+  "name": "A String", # Identifier. Name of the resource enrollment status, in one of the following formats: * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.projects.locations.standards.controls.html b/docs/dyn/auditmanager_v1.projects.locations.standards.controls.html new file mode 100644 index 0000000000..de4d20948d --- /dev/null +++ b/docs/dyn/auditmanager_v1.projects.locations.standards.controls.html @@ -0,0 +1,144 @@ + + + +

Audit Manager API . projects . locations . standards . controls

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists the controls that you must implement to become compliant to a regulatory standard.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the controls that you must implement to become compliant to a regulatory standard.
+
+Args:
+  parent: string, Required. Standard to list controls for, in one of the following formats: * `projects/{project}/locations/{location}/standards/{standard}` * `folders/{folder}/locations/{location}/standards/{standard}` * `organizations/{organization}/locations/{location}/standards/{standard}` (required)
+  pageSize: integer, Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
+  pageToken: string, Optional. A page token, received from a previous call, to retrieve the next page of 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 ListControls.
+  "controls": [ # Output only. Controls for a given regulatory standard.
+    { # A control.
+      "controlFamily": { # Regulatory family of the control. # Output only. Regulatory family of the control.
+        "displayName": "A String", # Display name of the regulatory control family.
+        "familyId": "A String", # ID of the regulatory control family. To find the list of supported control families, use the ListControls method and review the `control_family` field in the response.
+      },
+      "customerResponsibilityDescription": "A String", # Output only. A description of your responsibility for this control.
+      "customerResponsibilityImplementation": "A String", # Output only. A description of how you can implement your responsibility for this control.
+      "description": "A String", # Output only. Description of the control.
+      "displayName": "A String", # Output only. Display name of the control.
+      "family": "A String", # Output only. Category that the control belongs to.
+      "googleResponsibilityDescription": "A String", # Output only. A description of Google's responsibility for this control.
+      "googleResponsibilityImplementation": "A String", # Output only. A description of how Google implements its responsibility for this control.
+      "id": "A String", # Output only. Control identifier that's used to fetch the findings. The identifier is the same as the control report name.
+      "responsibilityType": "A String", # Output only. Who is responsible for implementing this control. Set to one of the following values: `GOOGLE`, `CUSTOMER`, or `SHARED`.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. A token that you can send as the `page_token` in a subsequent request to retrieve the next page of results. If this field is empty, there are no subsequent pages.
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/auditmanager_v1.projects.locations.standards.html b/docs/dyn/auditmanager_v1.projects.locations.standards.html new file mode 100644 index 0000000000..e0abcfcbc0 --- /dev/null +++ b/docs/dyn/auditmanager_v1.projects.locations.standards.html @@ -0,0 +1,91 @@ + + + +

Audit Manager API . projects . locations . standards

+

Instance Methods

+

+ controls() +

+

Returns the controls Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1beta.folders.html b/docs/dyn/backupdr_v1beta.folders.html new file mode 100644 index 0000000000..593dc01a3d --- /dev/null +++ b/docs/dyn/backupdr_v1beta.folders.html @@ -0,0 +1,91 @@ + + + +

Backup and DR Service 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/backupdr_v1beta.folders.locations.html b/docs/dyn/backupdr_v1beta.folders.locations.html new file mode 100644 index 0000000000..a40201f6ec --- /dev/null +++ b/docs/dyn/backupdr_v1beta.folders.locations.html @@ -0,0 +1,91 @@ + + + +

Backup and DR Service API . folders . locations

+

Instance Methods

+

+ resourceBackupConfigs() +

+

Returns the resourceBackupConfigs Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1beta.folders.locations.resourceBackupConfigs.html b/docs/dyn/backupdr_v1beta.folders.locations.resourceBackupConfigs.html new file mode 100644 index 0000000000..c73db02c64 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.folders.locations.resourceBackupConfigs.html @@ -0,0 +1,175 @@ + + + +

Backup and DR Service API . folders . locations . resourceBackupConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Fetches ResourceBackupConfigs.

+

+ fetch_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ fetch(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Fetches ResourceBackupConfigs.
+
+Args:
+  parent: string, Required. The project, folder or organization and location for which to retrieve resource backup configs. Format: 'projects/{project_id}/locations/{location}', 'folders/{folder_id}/locations/{location}', or 'organizations/{organization_id}/locations/{location}'. (required)
+  filter: string, Optional. Filtering results.
+  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 use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500.
+  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 for FetchResourceBackupConfigs.
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "resourceBackupConfigs": [ # The list of ResourceBackupConfigs for the specified scope.
+    { # ResourceBackupConfig represents a resource along with its backup configurations.
+      "backupConfigsDetails": [ # Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.
+        { # BackupConfigDetails has information about how the resource is configured for backups and about the most recent backup taken for this configuration.
+          "applicableResource": "A String", # Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the resource that is applicable for the backup configuration. Example: "//compute.googleapis.com/projects/{project}/zones/{zone}/instances/{instance}"
+          "backupConfigSource": "A String", # Output only. The full resource name of the backup config source resource. For example, "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupPlans/{backupplanId}" or "//compute.googleapis.com/projects/{project}/locations/{region}/resourcePolicies/{resourcePolicyId}".
+          "backupConfigSourceDisplayName": "A String", # Output only. The display name of the backup config source resource.
+          "backupDrPlanConfig": { # BackupDrPlanConfig has additional information about Google Cloud Backup and DR's Plan backup configuration. # Google Cloud Backup and DR's Backup Plan specific data.
+            "backupDrPlanRules": [ # Backup rules of the backup plan resource.
+              { # BackupDrPlanRule has rule specific information of the backup plan resource.
+                "lastSuccessfulBackupTime": "A String", # Output only. Timestamp of the latest successful backup created via this backup rule.
+                "ruleId": "A String", # Output only. Unique Id of the backup rule.
+              },
+            ],
+          },
+          "backupDrTemplateConfig": { # Provides additional information about Google Cloud Backup and DR's Template backup configuration. # Google Cloud Backup and DR's Template specific data.
+            "firstPartyManagementUri": "A String", # Output only. The URI of the BackupDr template resource for the first party identity users.
+            "thirdPartyManagementUri": "A String", # Output only. The URI of the BackupDr template resource for the third party identity users.
+          },
+          "backupLocations": [ # The locations where the backups are to be stored.
+            { # BackupLocation represents a cloud location where a backup can be stored.
+              "locationId": "A String", # Output only. The id of the cloud location. Example: "us-central1"
+              "type": "A String", # Output only. The type of the location.
+            },
+          ],
+          "backupVault": "A String", # Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the backup vault that will store the backups generated through this backup configuration. Example: "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupVaults/{backupvaultId}"
+          "latestSuccessfulBackupTime": "A String", # Output only. Timestamp of the latest successful backup created via this backup configuration.
+          "pitrSettings": { # Point in time recovery settings of the backup configuration resource. # Output only. Point in time recovery settings of the backup configuration resource.
+            "retentionDays": 42, # Output only. Number of days to retain the backup.
+          },
+          "state": "A String", # Output only. The state of the backup config resource.
+          "type": "A String", # Output only. The type of the backup config resource.
+        },
+      ],
+      "backupConfigured": True or False, # Output only. Whether the target resource is configured for backup. This is true if the backup_configs_details is not empty.
+      "name": "A String", # Identifier. The resource name of the ResourceBackupConfig. Format: projects/{project}/locations/{location}/resourceBackupConfigs/{uid}
+      "targetResource": "A String", # Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the cloud resource that this configuration applies to. Supported resource types are ResourceBackupConfig.ResourceType.
+      "targetResourceDisplayName": "A String", # Output only. The human friendly name of the target resource.
+      "targetResourceLabels": { # Labels associated with the target resource.
+        "a_key": "A String",
+      },
+      "targetResourceType": "A String", # Output only. The type of the target resource.
+      "uid": "A String", # Output only. The unique identifier of the resource backup config.
+      "vaulted": True or False, # Output only. Whether the target resource is protected by a backup vault. This is true if the backup_configs_details is not empty and any of the ResourceBackupConfig.backup_configs_details has a backup configuration with BackupConfigDetails.backup_vault set.
+    },
+  ],
+}
+
+ +
+ fetch_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1beta.html b/docs/dyn/backupdr_v1beta.html new file mode 100644 index 0000000000..042043c7b1 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.html @@ -0,0 +1,121 @@ + + + +

Backup and DR Service API

+

Instance Methods

+

+ folders() +

+

Returns the folders Resource.

+ +

+ organizations() +

+

Returns the organizations Resource.

+ +

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request(callback=None)

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request(callback=None) +
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/backupdr_v1beta.organizations.html b/docs/dyn/backupdr_v1beta.organizations.html new file mode 100644 index 0000000000..7f8a0ea91b --- /dev/null +++ b/docs/dyn/backupdr_v1beta.organizations.html @@ -0,0 +1,91 @@ + + + +

Backup and DR Service API . organizations

+

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/backupdr_v1beta.organizations.locations.html b/docs/dyn/backupdr_v1beta.organizations.locations.html new file mode 100644 index 0000000000..0cb4861af2 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.organizations.locations.html @@ -0,0 +1,91 @@ + + + +

Backup and DR Service API . organizations . locations

+

Instance Methods

+

+ resourceBackupConfigs() +

+

Returns the resourceBackupConfigs Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1beta.organizations.locations.resourceBackupConfigs.html b/docs/dyn/backupdr_v1beta.organizations.locations.resourceBackupConfigs.html new file mode 100644 index 0000000000..8621ae6172 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.organizations.locations.resourceBackupConfigs.html @@ -0,0 +1,175 @@ + + + +

Backup and DR Service API . organizations . locations . resourceBackupConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Fetches ResourceBackupConfigs.

+

+ fetch_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ fetch(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Fetches ResourceBackupConfigs.
+
+Args:
+  parent: string, Required. The project, folder or organization and location for which to retrieve resource backup configs. Format: 'projects/{project_id}/locations/{location}', 'folders/{folder_id}/locations/{location}', or 'organizations/{organization_id}/locations/{location}'. (required)
+  filter: string, Optional. Filtering results.
+  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 use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500.
+  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 for FetchResourceBackupConfigs.
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "resourceBackupConfigs": [ # The list of ResourceBackupConfigs for the specified scope.
+    { # ResourceBackupConfig represents a resource along with its backup configurations.
+      "backupConfigsDetails": [ # Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.
+        { # BackupConfigDetails has information about how the resource is configured for backups and about the most recent backup taken for this configuration.
+          "applicableResource": "A String", # Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the resource that is applicable for the backup configuration. Example: "//compute.googleapis.com/projects/{project}/zones/{zone}/instances/{instance}"
+          "backupConfigSource": "A String", # Output only. The full resource name of the backup config source resource. For example, "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupPlans/{backupplanId}" or "//compute.googleapis.com/projects/{project}/locations/{region}/resourcePolicies/{resourcePolicyId}".
+          "backupConfigSourceDisplayName": "A String", # Output only. The display name of the backup config source resource.
+          "backupDrPlanConfig": { # BackupDrPlanConfig has additional information about Google Cloud Backup and DR's Plan backup configuration. # Google Cloud Backup and DR's Backup Plan specific data.
+            "backupDrPlanRules": [ # Backup rules of the backup plan resource.
+              { # BackupDrPlanRule has rule specific information of the backup plan resource.
+                "lastSuccessfulBackupTime": "A String", # Output only. Timestamp of the latest successful backup created via this backup rule.
+                "ruleId": "A String", # Output only. Unique Id of the backup rule.
+              },
+            ],
+          },
+          "backupDrTemplateConfig": { # Provides additional information about Google Cloud Backup and DR's Template backup configuration. # Google Cloud Backup and DR's Template specific data.
+            "firstPartyManagementUri": "A String", # Output only. The URI of the BackupDr template resource for the first party identity users.
+            "thirdPartyManagementUri": "A String", # Output only. The URI of the BackupDr template resource for the third party identity users.
+          },
+          "backupLocations": [ # The locations where the backups are to be stored.
+            { # BackupLocation represents a cloud location where a backup can be stored.
+              "locationId": "A String", # Output only. The id of the cloud location. Example: "us-central1"
+              "type": "A String", # Output only. The type of the location.
+            },
+          ],
+          "backupVault": "A String", # Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the backup vault that will store the backups generated through this backup configuration. Example: "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupVaults/{backupvaultId}"
+          "latestSuccessfulBackupTime": "A String", # Output only. Timestamp of the latest successful backup created via this backup configuration.
+          "pitrSettings": { # Point in time recovery settings of the backup configuration resource. # Output only. Point in time recovery settings of the backup configuration resource.
+            "retentionDays": 42, # Output only. Number of days to retain the backup.
+          },
+          "state": "A String", # Output only. The state of the backup config resource.
+          "type": "A String", # Output only. The type of the backup config resource.
+        },
+      ],
+      "backupConfigured": True or False, # Output only. Whether the target resource is configured for backup. This is true if the backup_configs_details is not empty.
+      "name": "A String", # Identifier. The resource name of the ResourceBackupConfig. Format: projects/{project}/locations/{location}/resourceBackupConfigs/{uid}
+      "targetResource": "A String", # Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the cloud resource that this configuration applies to. Supported resource types are ResourceBackupConfig.ResourceType.
+      "targetResourceDisplayName": "A String", # Output only. The human friendly name of the target resource.
+      "targetResourceLabels": { # Labels associated with the target resource.
+        "a_key": "A String",
+      },
+      "targetResourceType": "A String", # Output only. The type of the target resource.
+      "uid": "A String", # Output only. The unique identifier of the resource backup config.
+      "vaulted": True or False, # Output only. Whether the target resource is protected by a backup vault. This is true if the backup_configs_details is not empty and any of the ResourceBackupConfig.backup_configs_details has a backup configuration with BackupConfigDetails.backup_vault set.
+    },
+  ],
+}
+
+ +
+ fetch_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1beta.projects.html b/docs/dyn/backupdr_v1beta.projects.html new file mode 100644 index 0000000000..353029aa66 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.html @@ -0,0 +1,91 @@ + + + +

Backup and DR Service 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/backupdr_v1beta.projects.locations.appliedAutoProtectionPolicies.html b/docs/dyn/backupdr_v1beta.projects.locations.appliedAutoProtectionPolicies.html new file mode 100644 index 0000000000..b3de01c69f --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.locations.appliedAutoProtectionPolicies.html @@ -0,0 +1,164 @@ + + + +

Backup and DR Service API . projects . locations . appliedAutoProtectionPolicies

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists AppliedAutoProtectionPolicies in a given project and location.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists AppliedAutoProtectionPolicies in a given project and location.
+
+Args:
+  parent: string, Required. The project and location for which to retrieve the list of applied policies. Format: projects/{project}/locations/{location} (required)
+  filter: string, Optional. A filter expression that filters resources listed in the response.
+  orderBy: string, Optional. An expression that sorts the results in the response.
+  pageSize: integer, Optional. The maximum number of applied policies to return in a single page.
+  pageToken: string, Optional. A page token, received from a previous `ListAppliedAutoProtectionPolicies` 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 ListAppliedAutoProtectionPolicies.
+  "appliedAutoProtectionPolicies": [ # A list of the AppliedAutoProtectionPolicy resources found.
+    { # AppliedAutoProtectionPolicy is a read-only view of AutoProtectionPolicy and AutoProtectionPolicyBinding resources that apply to a given workload project.
+      "backupPlanDetails": [ # Output only. The set of backup plan configurations, mirroring the backup_plan_details from the source AutoProtectionPolicy. Each element specifies a backup plan for a given resource type.
+        { # BackupPlanDetail defines configuration of protection.
+          "backupPlan": "A String", # Required. The resource name of the BackupPlan to apply to resources that match the policy's criteria. This backup plan must be in the same location as AutoProtectionPolicy. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
+          "resourceType": "A String", # Required. The type of resource that this policy will automatically protect. For MVP, `compute.googleapis.com/Instance` and `compute.googleapis.com/Disk` are supported.
+        },
+      ],
+      "bindingEvaluationSummary": { # BindingEvaluationSummary contains the summary of the last run of job that applies policy to matching resources for a given binding. # Output only. The summary of the last policy application when the job has run.
+        "failedResourceCount": "A String", # Output only. The number of matching resources whose protection failed during job run.
+        "matchingResourceCount": "A String", # Output only. The number of resources that currently match the policy's criteria.
+        "protectedResourceCount": "A String", # Output only. The number of matching resources that are successfully protected.
+      },
+      "createTime": "A String", # Output only. Timestamp indicating when the binding was last created.
+      "criteria": { # Criteria specifies a set of criteria for matching resources. # Output only. The criteria resources must meet for this rule to apply. From AutoProtectionPolicy.criteria.
+        "matchingConditions": [ # Required. A list of matching conditions that a resource must meet to be protected by the policy.
+          { # MatchingCondition specifies a set of conditions for matching resources.
+            "labelCondition": { # KeyValuePair defines a key-value pair for matching resource labels. # Optional. A condition that matches resources based on their labels. For MVP, this is limited to a single label match.
+              "key": "A String", # Required. The key of the label to match. This must be in the format `{label_key}`. The key must match the regex Format:`\p{Ll}\p{Lo}{0,62}`.
+              "values": [ # Required. The values of the label to match. There will be explicit “OR” between values of array. Each value must be in the format `{label_value}`. The value must match the regex Format: `[\\p{Ll}\\p{Lo}\\p{N}_-]{1,63}`.
+                "A String",
+              ],
+            },
+          },
+        ],
+      },
+      "name": "A String", # Identifier. Canonical resource name. Format: projects/{workload-project-number}/locations/{location}/appliedAutoProtectionPolicies/{id}.
+      "sourceBinding": "A String", # Output only. The full resource name of the AutoProtectionPolicyBinding that applies the source policy to a scope including this workload project. e.g., projects/{admin-project}/locations/{location}/autoProtectionPolicies/{policy_id}/autoProtectionPolicyBindings/{binding_id}.
+      "status": "A String", # Output only. The status of the applied auto protection policy.
+      "updateTime": "A String", # Output only. Timestamp indicating when the binding was last modified.
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.bindings.html b/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.bindings.html new file mode 100644 index 0000000000..bdcf6d7847 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.bindings.html @@ -0,0 +1,287 @@ + + + +

Backup and DR Service API . projects . locations . autoProtectionPolicies . bindings

+

Instance Methods

+

+ matchingResources() +

+

Returns the matchingResources Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new AutoProtectionPolicyBinding in a given project and location.

+

+ get(name, x__xgafv=None)

+

Returns the auto protection policy binding read from the CCFE tables.

+

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

+

InitiateDeleteAutoProtectionPolicyBinding initiates delete for AutoProtectionPolicy Binding

+

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

+

Returns the auto protection policy bindings read from the CCFE tables.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, autoProtectionPolicyBindingId=None, body=None, x__xgafv=None) +
Creates a new AutoProtectionPolicyBinding in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource where this binding will be created. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An AutoprotectionPolicyBinding (APPA) acts as the bridge between an AutoprotectionPolicy and the scope (Project, Folder, or Organization) where the policy should be applied.
+  "bindingEvaluationSummary": { # BindingEvaluationSummary contains the summary of the last run of job that applies policy to matching resources for a given binding. # Output only. Summaries of the last policy application when the job has run, with one entry per resource type specified in the AutoProtectionPolicy.
+    "failedResourceCount": "A String", # Output only. The number of matching resources whose protection failed during job run.
+    "matchingResourceCount": "A String", # Output only. The number of resources that currently match the policy's criteria.
+    "protectedResourceCount": "A String", # Output only. The number of matching resources that are successfully protected.
+  },
+  "createTime": "A String", # Output only. The timestamp when the binding was created.
+  "description": "A String", # Optional. A description of the binding.
+  "etag": "A String", # Optional. Output only. The etag for the binding. If this is provided on update, it must match the server's etag.
+  "name": "A String", # Identifier. The resource name of the AutoProtectionPolicyBinding. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}`
+  "scope": "A String", # Required. Immutable. Resource Id of target container on which policy will be applied. Format: projects/{project_id}
+  "state": "A String", # Output only. The current state of the AutoProtectionPolicyBinding.
+  "updateTime": "A String", # Output only. The timestamp when the binding was last updated.
+}
+
+  autoProtectionPolicyBindingId: string, Required. The ID to use for the binding. This will become the final component of the binding's resource name.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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) +
Returns the auto protection policy binding read from the CCFE tables.
+
+Args:
+  name: string, Required. The name of the binding to retrieve. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An AutoprotectionPolicyBinding (APPA) acts as the bridge between an AutoprotectionPolicy and the scope (Project, Folder, or Organization) where the policy should be applied.
+  "bindingEvaluationSummary": { # BindingEvaluationSummary contains the summary of the last run of job that applies policy to matching resources for a given binding. # Output only. Summaries of the last policy application when the job has run, with one entry per resource type specified in the AutoProtectionPolicy.
+    "failedResourceCount": "A String", # Output only. The number of matching resources whose protection failed during job run.
+    "matchingResourceCount": "A String", # Output only. The number of resources that currently match the policy's criteria.
+    "protectedResourceCount": "A String", # Output only. The number of matching resources that are successfully protected.
+  },
+  "createTime": "A String", # Output only. The timestamp when the binding was created.
+  "description": "A String", # Optional. A description of the binding.
+  "etag": "A String", # Optional. Output only. The etag for the binding. If this is provided on update, it must match the server's etag.
+  "name": "A String", # Identifier. The resource name of the AutoProtectionPolicyBinding. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}`
+  "scope": "A String", # Required. Immutable. Resource Id of target container on which policy will be applied. Format: projects/{project_id}
+  "state": "A String", # Output only. The current state of the AutoProtectionPolicyBinding.
+  "updateTime": "A String", # Output only. The timestamp when the binding was last updated.
+}
+
+ +
+ initiateDelete(name, body=None, x__xgafv=None) +
InitiateDeleteAutoProtectionPolicyBinding initiates delete for AutoProtectionPolicy Binding
+
+Args:
+  name: string, Required. The name of the binding to delete. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for initiating delete of an AutoProtectionPolicyBinding.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns the auto protection policy bindings read from the CCFE tables.
+
+Args:
+  parent: string, Required. The project and location for which to retrieve the list of policies. Format: projects/{project}/locations/{location} (required)
+  filter: string, Optional. A filter expression that filters resources listed in the response. The following fields are filterable:
+  orderBy: string, Optional. An expression that sorts the results in the response. The following fields are sortable:
+  pageSize: integer, Optional. The maximum number of policies to return in a single page. If unspecified, a server-default value will be used.
+  pageToken: string, Optional. A page token, received from a previous `ListAutoProtectionPolicies` 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 ListAutoProtectionPolicyBindings.
+  "autoProtectionPolicyBindings": [ # A list of the AutoProtectionPolicyBindings resources found.
+    { # An AutoprotectionPolicyBinding (APPA) acts as the bridge between an AutoprotectionPolicy and the scope (Project, Folder, or Organization) where the policy should be applied.
+      "bindingEvaluationSummary": { # BindingEvaluationSummary contains the summary of the last run of job that applies policy to matching resources for a given binding. # Output only. Summaries of the last policy application when the job has run, with one entry per resource type specified in the AutoProtectionPolicy.
+        "failedResourceCount": "A String", # Output only. The number of matching resources whose protection failed during job run.
+        "matchingResourceCount": "A String", # Output only. The number of resources that currently match the policy's criteria.
+        "protectedResourceCount": "A String", # Output only. The number of matching resources that are successfully protected.
+      },
+      "createTime": "A String", # Output only. The timestamp when the binding was created.
+      "description": "A String", # Optional. A description of the binding.
+      "etag": "A String", # Optional. Output only. The etag for the binding. If this is provided on update, it must match the server's etag.
+      "name": "A String", # Identifier. The resource name of the AutoProtectionPolicyBinding. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}`
+      "scope": "A String", # Required. Immutable. Resource Id of target container on which policy will be applied. Format: projects/{project_id}
+      "state": "A String", # Output only. The current state of the AutoProtectionPolicyBinding.
+      "updateTime": "A String", # Output only. The timestamp when the binding was last updated.
+    },
+  ],
+  "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.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.bindings.matchingResources.html b/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.bindings.matchingResources.html new file mode 100644 index 0000000000..4123543fe1 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.bindings.matchingResources.html @@ -0,0 +1,188 @@ + + + +

Backup and DR Service API . projects . locations . autoProtectionPolicies . bindings . matchingResources

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details of a single Binding Matching Resource.

+

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

+

Lists Binding Matching Resources for a given AutoProtectionPolicyBinding.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single Binding Matching Resource.
+
+Args:
+  name: string, Required. The name of the matching resource to retrieve. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # BindingMatchingResource contains the details of a resource that matches the criteria of a binding.
+  "autoProtectionDetails": { # AutoProtectionDetails contains the protection details of a resource from the current binding's perspective. # Output only. The auto protection details of the resource from the current binding's perspective.
+    "backupPlanAssociation": "A String", # Output only. Resource name of backup plan association linked to the resource, if any. Format: projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
+    "dataSource": "A String", # Output only. Resource name of the datasource linked to the resource, if any. Format: projects/{project}/locations/{location}/backupVaults/{backupVaultId}/dataSources/{dataSourceId}
+    "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. Error during last sync for protection/unprotection, if any.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+      ],
+      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+    },
+    "state": "A String", # Output only. Protection state of the resource from the current binding's perspective. Output only.
+  },
+  "lastEvaluationTime": "A String", # Output only. The timestamp when the resource was last evaluated for protection.
+  "name": "A String", # Identifier. The resource name of the `BindingMatchingResource`. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}`
+  "resource": "A String", # Required. Immutable. Resource name of the workload that matches the criteria of the binding. The format can be either a relative resource name (e.g., `projects/my-project/zones/us-central1-a/instances/my-instance`) or a schemeless full resource name (e.g., `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`).
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Binding Matching Resources for a given AutoProtectionPolicyBinding.
+
+Args:
+  parent: string, Required. The project, location, auto protection policy and binding for which to retrieve `BindingMatchingResources` information. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}`. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. (required)
+  filter: string, Optional. Field match expression used to filter the results.
+  orderBy: string, Optional. Field by which to sort the results.
+  pageSize: integer, Optional. The maximum number of `BindingMatchingResources` to return in a single response. The default page size is 100 and maximum page size is 200. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
+  pageToken: string, Optional. The value of next_page_token received from a previous `ListBindingMatchingResources` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBindingMatchingResources` 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:
+
+    { # The response message for getting a list of `BindingMatchingResources`.
+  "matchingResources": [ # The list of `BindingMatchingResources` in the project,location for the specified binding.
+    { # BindingMatchingResource contains the details of a resource that matches the criteria of a binding.
+      "autoProtectionDetails": { # AutoProtectionDetails contains the protection details of a resource from the current binding's perspective. # Output only. The auto protection details of the resource from the current binding's perspective.
+        "backupPlanAssociation": "A String", # Output only. Resource name of backup plan association linked to the resource, if any. Format: projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
+        "dataSource": "A String", # Output only. Resource name of the datasource linked to the resource, if any. Format: projects/{project}/locations/{location}/backupVaults/{backupVaultId}/dataSources/{dataSourceId}
+        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. Error during last sync for protection/unprotection, if any.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # Output only. Protection state of the resource from the current binding's perspective. Output only.
+      },
+      "lastEvaluationTime": "A String", # Output only. The timestamp when the resource was last evaluated for protection.
+      "name": "A String", # Identifier. The resource name of the `BindingMatchingResource`. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}`
+      "resource": "A String", # Required. Immutable. Resource name of the workload that matches the criteria of the binding. The format can be either a relative resource name (e.g., `projects/my-project/zones/us-central1-a/instances/my-instance`) or a schemeless full resource name (e.g., `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`).
+    },
+  ],
+  "nextPageToken": "A String", # A token which may be sent as page_token in a subsequent `ListBindingMatchingResources` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.html b/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.html new file mode 100644 index 0000000000..eda3cdd0c8 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.html @@ -0,0 +1,419 @@ + + + +

Backup and DR Service API . projects . locations . autoProtectionPolicies

+

Instance Methods

+

+ bindings() +

+

Returns the bindings Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new AutoProtectionPolicy in a given project and location.

+

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

+

Deletes a single AutoProtectionPolicy.

+

+ get(name, x__xgafv=None)

+

Gets details of a single AutoProtectionPolicy.

+

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

+

Lists AutoProtectionPolicies for a given project and location.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates the parameters of a single AutoProtectionPolicy.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, autoProtectionPolicyId=None, body=None, x__xgafv=None) +
Creates a new AutoProtectionPolicy in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource where this policy will be created. Format: projects/{project}/locations/{location} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An AutoprotectionPolicy is a policy resource designed to automate backup management, moving from manual per-resource protection to a bulk approach. The policy dynamically discovers and applies a specified backup plan to all eligible resources that match its defined scope and criteria.
+  "backupPlanDetails": [ # Required. The backup plan details for matching resources.
+    { # BackupPlanDetail defines configuration of protection.
+      "backupPlan": "A String", # Required. The resource name of the BackupPlan to apply to resources that match the policy's criteria. This backup plan must be in the same location as AutoProtectionPolicy. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
+      "resourceType": "A String", # Required. The type of resource that this policy will automatically protect. For MVP, `compute.googleapis.com/Instance` and `compute.googleapis.com/Disk` are supported.
+    },
+  ],
+  "bindingSummary": { # BindingSummary contains count of different containers covered through this policy. # Output only. Summary of total count of different containers covered through this policy.
+    "projectCount": "A String", # Output only. Total count of Projects protected with this policy.
+  },
+  "createTime": "A String", # Output only. The timestamp when the policy was created.
+  "criteria": { # Criteria specifies a set of criteria for matching resources. # Required. The criteria for matching resources.
+    "matchingConditions": [ # Required. A list of matching conditions that a resource must meet to be protected by the policy.
+      { # MatchingCondition specifies a set of conditions for matching resources.
+        "labelCondition": { # KeyValuePair defines a key-value pair for matching resource labels. # Optional. A condition that matches resources based on their labels. For MVP, this is limited to a single label match.
+          "key": "A String", # Required. The key of the label to match. This must be in the format `{label_key}`. The key must match the regex Format:`\p{Ll}\p{Lo}{0,62}`.
+          "values": [ # Required. The values of the label to match. There will be explicit “OR” between values of array. Each value must be in the format `{label_value}`. The value must match the regex Format: `[\\p{Ll}\\p{Lo}\\p{N}_-]{1,63}`.
+            "A String",
+          ],
+        },
+      },
+    ],
+  },
+  "description": "A String", # Optional. A description of the policy.
+  "etag": "A String", # Output only. The etag for the policy. If this is provided on update, it must match the server's etag, otherwise the request will be rejected with an ABORTED error.
+  "name": "A String", # Identifier. The resource name of the AutoprotectionPolicy. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}`
+  "policyEvaluationSummary": { # PolicyEvaluationSummary contains the summary of the last run of job that applies policy to matching resources. # Output only. Summary of last policy application when job was run per workload type.
+    "failedResourceCount": "A String", # Output only. The number of matching resources whose protection failed during job run.
+    "matchingResourceCount": "A String", # Output only. The number of resources that currently match the policy's criteria.
+    "protectedResourceCount": "A String", # Output only. The number of matching resources that are successfully protected.
+  },
+  "state": "A String", # Output only. The current state of the AutoprotectionPolicy.
+  "updateTime": "A String", # Output only. The timestamp when the policy was last updated.
+}
+
+  autoProtectionPolicyId: string, Required. The ID to use for the policy. This will become the final component of the policy's resource name.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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 AutoProtectionPolicy.
+
+Args:
+  name: string, Required. The name of the policy to delete. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy} (required)
+  etag: string, The current etag of the AutoProtectionPolicy. If an etag is provided and does not match the current etag of the connection, the request will be rejected with an ABORTED error.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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 AutoProtectionPolicy.
+
+Args:
+  name: string, Required. The name of the policy to retrieve. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An AutoprotectionPolicy is a policy resource designed to automate backup management, moving from manual per-resource protection to a bulk approach. The policy dynamically discovers and applies a specified backup plan to all eligible resources that match its defined scope and criteria.
+  "backupPlanDetails": [ # Required. The backup plan details for matching resources.
+    { # BackupPlanDetail defines configuration of protection.
+      "backupPlan": "A String", # Required. The resource name of the BackupPlan to apply to resources that match the policy's criteria. This backup plan must be in the same location as AutoProtectionPolicy. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
+      "resourceType": "A String", # Required. The type of resource that this policy will automatically protect. For MVP, `compute.googleapis.com/Instance` and `compute.googleapis.com/Disk` are supported.
+    },
+  ],
+  "bindingSummary": { # BindingSummary contains count of different containers covered through this policy. # Output only. Summary of total count of different containers covered through this policy.
+    "projectCount": "A String", # Output only. Total count of Projects protected with this policy.
+  },
+  "createTime": "A String", # Output only. The timestamp when the policy was created.
+  "criteria": { # Criteria specifies a set of criteria for matching resources. # Required. The criteria for matching resources.
+    "matchingConditions": [ # Required. A list of matching conditions that a resource must meet to be protected by the policy.
+      { # MatchingCondition specifies a set of conditions for matching resources.
+        "labelCondition": { # KeyValuePair defines a key-value pair for matching resource labels. # Optional. A condition that matches resources based on their labels. For MVP, this is limited to a single label match.
+          "key": "A String", # Required. The key of the label to match. This must be in the format `{label_key}`. The key must match the regex Format:`\p{Ll}\p{Lo}{0,62}`.
+          "values": [ # Required. The values of the label to match. There will be explicit “OR” between values of array. Each value must be in the format `{label_value}`. The value must match the regex Format: `[\\p{Ll}\\p{Lo}\\p{N}_-]{1,63}`.
+            "A String",
+          ],
+        },
+      },
+    ],
+  },
+  "description": "A String", # Optional. A description of the policy.
+  "etag": "A String", # Output only. The etag for the policy. If this is provided on update, it must match the server's etag, otherwise the request will be rejected with an ABORTED error.
+  "name": "A String", # Identifier. The resource name of the AutoprotectionPolicy. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}`
+  "policyEvaluationSummary": { # PolicyEvaluationSummary contains the summary of the last run of job that applies policy to matching resources. # Output only. Summary of last policy application when job was run per workload type.
+    "failedResourceCount": "A String", # Output only. The number of matching resources whose protection failed during job run.
+    "matchingResourceCount": "A String", # Output only. The number of resources that currently match the policy's criteria.
+    "protectedResourceCount": "A String", # Output only. The number of matching resources that are successfully protected.
+  },
+  "state": "A String", # Output only. The current state of the AutoprotectionPolicy.
+  "updateTime": "A String", # Output only. The timestamp when the policy was last updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists AutoProtectionPolicies for a given project and location.
+
+Args:
+  parent: string, Required. The project and location for which to retrieve the list of policies. Format: projects/{project}/locations/{location} (required)
+  filter: string, Optional. A filter expression that filters resources listed in the response. The following fields are filterable:
+  orderBy: string, Optional. An expression that sorts the results in the response. The following fields are sortable:
+  pageSize: integer, Optional. The maximum number of policies to return in a single page. If unspecified, a server-default value will be used.
+  pageToken: string, Optional. A page token, received from a previous `ListAutoProtectionPolicies` 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 ListAutoProtectionPolicies.
+  "autoProtectionPolicies": [ # A list of the AutoProtectionPolicy resources found.
+    { # An AutoprotectionPolicy is a policy resource designed to automate backup management, moving from manual per-resource protection to a bulk approach. The policy dynamically discovers and applies a specified backup plan to all eligible resources that match its defined scope and criteria.
+      "backupPlanDetails": [ # Required. The backup plan details for matching resources.
+        { # BackupPlanDetail defines configuration of protection.
+          "backupPlan": "A String", # Required. The resource name of the BackupPlan to apply to resources that match the policy's criteria. This backup plan must be in the same location as AutoProtectionPolicy. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
+          "resourceType": "A String", # Required. The type of resource that this policy will automatically protect. For MVP, `compute.googleapis.com/Instance` and `compute.googleapis.com/Disk` are supported.
+        },
+      ],
+      "bindingSummary": { # BindingSummary contains count of different containers covered through this policy. # Output only. Summary of total count of different containers covered through this policy.
+        "projectCount": "A String", # Output only. Total count of Projects protected with this policy.
+      },
+      "createTime": "A String", # Output only. The timestamp when the policy was created.
+      "criteria": { # Criteria specifies a set of criteria for matching resources. # Required. The criteria for matching resources.
+        "matchingConditions": [ # Required. A list of matching conditions that a resource must meet to be protected by the policy.
+          { # MatchingCondition specifies a set of conditions for matching resources.
+            "labelCondition": { # KeyValuePair defines a key-value pair for matching resource labels. # Optional. A condition that matches resources based on their labels. For MVP, this is limited to a single label match.
+              "key": "A String", # Required. The key of the label to match. This must be in the format `{label_key}`. The key must match the regex Format:`\p{Ll}\p{Lo}{0,62}`.
+              "values": [ # Required. The values of the label to match. There will be explicit “OR” between values of array. Each value must be in the format `{label_value}`. The value must match the regex Format: `[\\p{Ll}\\p{Lo}\\p{N}_-]{1,63}`.
+                "A String",
+              ],
+            },
+          },
+        ],
+      },
+      "description": "A String", # Optional. A description of the policy.
+      "etag": "A String", # Output only. The etag for the policy. If this is provided on update, it must match the server's etag, otherwise the request will be rejected with an ABORTED error.
+      "name": "A String", # Identifier. The resource name of the AutoprotectionPolicy. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}`
+      "policyEvaluationSummary": { # PolicyEvaluationSummary contains the summary of the last run of job that applies policy to matching resources. # Output only. Summary of last policy application when job was run per workload type.
+        "failedResourceCount": "A String", # Output only. The number of matching resources whose protection failed during job run.
+        "matchingResourceCount": "A String", # Output only. The number of resources that currently match the policy's criteria.
+        "protectedResourceCount": "A String", # Output only. The number of matching resources that are successfully protected.
+      },
+      "state": "A String", # Output only. The current state of the AutoprotectionPolicy.
+      "updateTime": "A String", # Output only. The timestamp when the policy was last updated.
+    },
+  ],
+  "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.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the parameters of a single AutoProtectionPolicy.
+
+Args:
+  name: string, Identifier. The resource name of the AutoprotectionPolicy. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An AutoprotectionPolicy is a policy resource designed to automate backup management, moving from manual per-resource protection to a bulk approach. The policy dynamically discovers and applies a specified backup plan to all eligible resources that match its defined scope and criteria.
+  "backupPlanDetails": [ # Required. The backup plan details for matching resources.
+    { # BackupPlanDetail defines configuration of protection.
+      "backupPlan": "A String", # Required. The resource name of the BackupPlan to apply to resources that match the policy's criteria. This backup plan must be in the same location as AutoProtectionPolicy. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
+      "resourceType": "A String", # Required. The type of resource that this policy will automatically protect. For MVP, `compute.googleapis.com/Instance` and `compute.googleapis.com/Disk` are supported.
+    },
+  ],
+  "bindingSummary": { # BindingSummary contains count of different containers covered through this policy. # Output only. Summary of total count of different containers covered through this policy.
+    "projectCount": "A String", # Output only. Total count of Projects protected with this policy.
+  },
+  "createTime": "A String", # Output only. The timestamp when the policy was created.
+  "criteria": { # Criteria specifies a set of criteria for matching resources. # Required. The criteria for matching resources.
+    "matchingConditions": [ # Required. A list of matching conditions that a resource must meet to be protected by the policy.
+      { # MatchingCondition specifies a set of conditions for matching resources.
+        "labelCondition": { # KeyValuePair defines a key-value pair for matching resource labels. # Optional. A condition that matches resources based on their labels. For MVP, this is limited to a single label match.
+          "key": "A String", # Required. The key of the label to match. This must be in the format `{label_key}`. The key must match the regex Format:`\p{Ll}\p{Lo}{0,62}`.
+          "values": [ # Required. The values of the label to match. There will be explicit “OR” between values of array. Each value must be in the format `{label_value}`. The value must match the regex Format: `[\\p{Ll}\\p{Lo}\\p{N}_-]{1,63}`.
+            "A String",
+          ],
+        },
+      },
+    ],
+  },
+  "description": "A String", # Optional. A description of the policy.
+  "etag": "A String", # Output only. The etag for the policy. If this is provided on update, it must match the server's etag, otherwise the request will be rejected with an ABORTED error.
+  "name": "A String", # Identifier. The resource name of the AutoprotectionPolicy. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}`
+  "policyEvaluationSummary": { # PolicyEvaluationSummary contains the summary of the last run of job that applies policy to matching resources. # Output only. Summary of last policy application when job was run per workload type.
+    "failedResourceCount": "A String", # Output only. The number of matching resources whose protection failed during job run.
+    "matchingResourceCount": "A String", # Output only. The number of resources that currently match the policy's criteria.
+    "protectedResourceCount": "A String", # Output only. The number of matching resources that are successfully protected.
+  },
+  "state": "A String", # Output only. The current state of the AutoprotectionPolicy.
+  "updateTime": "A String", # Output only. The timestamp when the policy was last updated.
+}
+
+  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the AutoProtectionPolicy 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/backupdr_v1beta.projects.locations.backupPlanAssociations.html b/docs/dyn/backupdr_v1beta.projects.locations.backupPlanAssociations.html new file mode 100644 index 0000000000..1b7a915843 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.locations.backupPlanAssociations.html @@ -0,0 +1,566 @@ + + + +

Backup and DR Service API . projects . locations . backupPlanAssociations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Create a BackupPlanAssociation

+

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

+

Deletes a single BackupPlanAssociation.

+

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

+

List BackupPlanAssociations for a given resource type.

+

+ fetchForResourceType_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ get(name, x__xgafv=None)

+

Gets details of a single BackupPlanAssociation.

+

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

+

Lists BackupPlanAssociations in a given project and location.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Update a BackupPlanAssociation.

+

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

+

Triggers a new Backup.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, backupPlanAssociationId=None, body=None, requestId=None, x__xgafv=None) +
Create a BackupPlanAssociation
+
+Args:
+  parent: string, Required. The backup plan association project and location in the format `projects/{project_id}/locations/{location}`. In Backup and DR locations map to Google Cloud regions, for example **us-central1**. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc
+  "alloydbClusterBackupPlanAssociationProperties": { # Properties for an AlloyDB cluster backup plan association. # Output only. AlloyDB cluster's backup plan association properties.
+    "clusterUid": "A String", # Output only. The cluster UID of the AlloyDB cluster.
+  },
+  "autoProtectionPolicyBinding": "A String", # Output only. The resource name of the `AutoProtectionPolicyBinding` that manages this association, if any. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}`.
+  "backupPlan": "A String", # Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
+  "backupPlanRevisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+  "backupPlanRevisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`
+  "cloudSqlInstanceBackupPlanAssociationProperties": { # Cloud SQL instance's BPA properties. # Output only. Cloud SQL instance's backup plan association properties.
+    "instanceCreateTime": "A String", # Output only. The time when the instance was created.
+  },
+  "createTime": "A String", # Output only. The time when the instance was created.
+  "dataSource": "A String", # Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}
+  "filestoreInstanceBackupPlanAssociationProperties": { # Filestore instance's BPA properties. # Output only. Filestore instance's backup plan association properties.
+    "instanceCreateTime": "A String", # Output only. The time when the instance was created.
+  },
+  "name": "A String", # Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
+  "resource": "A String", # Required. Immutable. Resource name of workload on which the backup plan is applied. The format can either be the resource name (e.g., "projects/my-project/zones/us-central1-a/instances/my-instance") or the full resource URI (e.g., "https://www.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances/my-instance").
+  "resourceType": "A String", # Required. Immutable. Resource type of workload on which backupplan is applied
+  "rulesConfigInfo": [ # Output only. The config info related to backup rules.
+    { # Message for rules config info.
+      "lastBackupError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. google.rpc.Status object to store the last backup 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.
+      },
+      "lastBackupState": "A String", # Output only. The last backup state for rule.
+      "lastSuccessfulBackupConsistencyTime": "A String", # Output only. The point in time when the last successful backup was captured from the source.
+      "ruleId": "A String", # Output only. Backup Rule id fetched from backup plan.
+    },
+  ],
+  "state": "A String", # Output only. The BackupPlanAssociation resource state.
+  "updateTime": "A String", # Output only. The time when the instance was updated.
+}
+
+  backupPlanAssociationId: string, Required. The name of the backup plan association to create. The name must be unique for the specified project and location.
+  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 t he 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:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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, autoProtectionPolicyBinding=None, requestId=None, x__xgafv=None) +
Deletes a single BackupPlanAssociation.
+
+Args:
+  name: string, Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` (required)
+  autoProtectionPolicyBinding: string, Optional. This field is exclusively used by Backup and DR's auto-protection feature. The resource name of the `AutoProtectionPolicyBinding` that triggered the deletion of this association. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}`.
+  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:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ fetchForResourceType(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, resourceType=None, x__xgafv=None) +
List BackupPlanAssociations for a given resource type.
+
+Args:
+  parent: string, Required. The parent resource name. Format: projects/{project}/locations/{location} (required)
+  filter: string, Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields: * resource * backup_plan * state * data_source * cloud_sql_instance_backup_plan_association_properties.instance_create_time
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * name
+  pageSize: integer, Optional. The maximum number of BackupPlanAssociations to return. The service may return fewer than this value. If unspecified, at most 50 BackupPlanAssociations will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+  pageToken: string, Optional. A page token, received from a previous call of `FetchBackupPlanAssociationsForResourceType`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchBackupPlanAssociationsForResourceType` must match the call that provided the page token.
+  resourceType: string, Required. The type of the Google Cloud resource. Ex: sql.googleapis.com/Instance
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the FetchBackupPlanAssociationsForResourceType method.
+  "backupPlanAssociations": [ # Output only. The BackupPlanAssociations from the specified parent.
+    { # A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc
+      "alloydbClusterBackupPlanAssociationProperties": { # Properties for an AlloyDB cluster backup plan association. # Output only. AlloyDB cluster's backup plan association properties.
+        "clusterUid": "A String", # Output only. The cluster UID of the AlloyDB cluster.
+      },
+      "autoProtectionPolicyBinding": "A String", # Output only. The resource name of the `AutoProtectionPolicyBinding` that manages this association, if any. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}`.
+      "backupPlan": "A String", # Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
+      "backupPlanRevisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+      "backupPlanRevisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`
+      "cloudSqlInstanceBackupPlanAssociationProperties": { # Cloud SQL instance's BPA properties. # Output only. Cloud SQL instance's backup plan association properties.
+        "instanceCreateTime": "A String", # Output only. The time when the instance was created.
+      },
+      "createTime": "A String", # Output only. The time when the instance was created.
+      "dataSource": "A String", # Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}
+      "filestoreInstanceBackupPlanAssociationProperties": { # Filestore instance's BPA properties. # Output only. Filestore instance's backup plan association properties.
+        "instanceCreateTime": "A String", # Output only. The time when the instance was created.
+      },
+      "name": "A String", # Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
+      "resource": "A String", # Required. Immutable. Resource name of workload on which the backup plan is applied. The format can either be the resource name (e.g., "projects/my-project/zones/us-central1-a/instances/my-instance") or the full resource URI (e.g., "https://www.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances/my-instance").
+      "resourceType": "A String", # Required. Immutable. Resource type of workload on which backupplan is applied
+      "rulesConfigInfo": [ # Output only. The config info related to backup rules.
+        { # Message for rules config info.
+          "lastBackupError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. google.rpc.Status object to store the last backup 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.
+          },
+          "lastBackupState": "A String", # Output only. The last backup state for rule.
+          "lastSuccessfulBackupConsistencyTime": "A String", # Output only. The point in time when the last successful backup was captured from the source.
+          "ruleId": "A String", # Output only. Backup Rule id fetched from backup plan.
+        },
+      ],
+      "state": "A String", # Output only. The BackupPlanAssociation resource state.
+      "updateTime": "A String", # Output only. The time when the instance was updated.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ fetchForResourceType_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single BackupPlanAssociation.
+
+Args:
+  name: string, Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc
+  "alloydbClusterBackupPlanAssociationProperties": { # Properties for an AlloyDB cluster backup plan association. # Output only. AlloyDB cluster's backup plan association properties.
+    "clusterUid": "A String", # Output only. The cluster UID of the AlloyDB cluster.
+  },
+  "autoProtectionPolicyBinding": "A String", # Output only. The resource name of the `AutoProtectionPolicyBinding` that manages this association, if any. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}`.
+  "backupPlan": "A String", # Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
+  "backupPlanRevisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+  "backupPlanRevisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`
+  "cloudSqlInstanceBackupPlanAssociationProperties": { # Cloud SQL instance's BPA properties. # Output only. Cloud SQL instance's backup plan association properties.
+    "instanceCreateTime": "A String", # Output only. The time when the instance was created.
+  },
+  "createTime": "A String", # Output only. The time when the instance was created.
+  "dataSource": "A String", # Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}
+  "filestoreInstanceBackupPlanAssociationProperties": { # Filestore instance's BPA properties. # Output only. Filestore instance's backup plan association properties.
+    "instanceCreateTime": "A String", # Output only. The time when the instance was created.
+  },
+  "name": "A String", # Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
+  "resource": "A String", # Required. Immutable. Resource name of workload on which the backup plan is applied. The format can either be the resource name (e.g., "projects/my-project/zones/us-central1-a/instances/my-instance") or the full resource URI (e.g., "https://www.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances/my-instance").
+  "resourceType": "A String", # Required. Immutable. Resource type of workload on which backupplan is applied
+  "rulesConfigInfo": [ # Output only. The config info related to backup rules.
+    { # Message for rules config info.
+      "lastBackupError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. google.rpc.Status object to store the last backup 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.
+      },
+      "lastBackupState": "A String", # Output only. The last backup state for rule.
+      "lastSuccessfulBackupConsistencyTime": "A String", # Output only. The point in time when the last successful backup was captured from the source.
+      "ruleId": "A String", # Output only. Backup Rule id fetched from backup plan.
+    },
+  ],
+  "state": "A String", # Output only. The BackupPlanAssociation resource state.
+  "updateTime": "A String", # Output only. The time when the instance was updated.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists BackupPlanAssociations in a given project and location.
+
+Args:
+  parent: string, Required. The project and location for which to retrieve backup Plan Associations information, in the format `projects/{project_id}/locations/{location}`. In Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backup plan associations for all locations, use "-" for the `{location}` value. (required)
+  filter: string, Optional. Filtering 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 message for List BackupPlanAssociation
+  "backupPlanAssociations": [ # The list of Backup Plan Associations 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 plan associations in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.
+    { # A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc
+      "alloydbClusterBackupPlanAssociationProperties": { # Properties for an AlloyDB cluster backup plan association. # Output only. AlloyDB cluster's backup plan association properties.
+        "clusterUid": "A String", # Output only. The cluster UID of the AlloyDB cluster.
+      },
+      "autoProtectionPolicyBinding": "A String", # Output only. The resource name of the `AutoProtectionPolicyBinding` that manages this association, if any. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}`.
+      "backupPlan": "A String", # Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
+      "backupPlanRevisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+      "backupPlanRevisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`
+      "cloudSqlInstanceBackupPlanAssociationProperties": { # Cloud SQL instance's BPA properties. # Output only. Cloud SQL instance's backup plan association properties.
+        "instanceCreateTime": "A String", # Output only. The time when the instance was created.
+      },
+      "createTime": "A String", # Output only. The time when the instance was created.
+      "dataSource": "A String", # Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}
+      "filestoreInstanceBackupPlanAssociationProperties": { # Filestore instance's BPA properties. # Output only. Filestore instance's backup plan association properties.
+        "instanceCreateTime": "A String", # Output only. The time when the instance was created.
+      },
+      "name": "A String", # Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
+      "resource": "A String", # Required. Immutable. Resource name of workload on which the backup plan is applied. The format can either be the resource name (e.g., "projects/my-project/zones/us-central1-a/instances/my-instance") or the full resource URI (e.g., "https://www.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances/my-instance").
+      "resourceType": "A String", # Required. Immutable. Resource type of workload on which backupplan is applied
+      "rulesConfigInfo": [ # Output only. The config info related to backup rules.
+        { # Message for rules config info.
+          "lastBackupError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. google.rpc.Status object to store the last backup 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.
+          },
+          "lastBackupState": "A String", # Output only. The last backup state for rule.
+          "lastSuccessfulBackupConsistencyTime": "A String", # Output only. The point in time when the last successful backup was captured from the source.
+          "ruleId": "A String", # Output only. Backup Rule id fetched from backup plan.
+        },
+      ],
+      "state": "A String", # Output only. The BackupPlanAssociation resource state.
+      "updateTime": "A String", # Output only. The time when the instance was updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Update a BackupPlanAssociation.
+
+Args:
+  name: string, Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc
+  "alloydbClusterBackupPlanAssociationProperties": { # Properties for an AlloyDB cluster backup plan association. # Output only. AlloyDB cluster's backup plan association properties.
+    "clusterUid": "A String", # Output only. The cluster UID of the AlloyDB cluster.
+  },
+  "autoProtectionPolicyBinding": "A String", # Output only. The resource name of the `AutoProtectionPolicyBinding` that manages this association, if any. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}`.
+  "backupPlan": "A String", # Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
+  "backupPlanRevisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+  "backupPlanRevisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`
+  "cloudSqlInstanceBackupPlanAssociationProperties": { # Cloud SQL instance's BPA properties. # Output only. Cloud SQL instance's backup plan association properties.
+    "instanceCreateTime": "A String", # Output only. The time when the instance was created.
+  },
+  "createTime": "A String", # Output only. The time when the instance was created.
+  "dataSource": "A String", # Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}
+  "filestoreInstanceBackupPlanAssociationProperties": { # Filestore instance's BPA properties. # Output only. Filestore instance's backup plan association properties.
+    "instanceCreateTime": "A String", # Output only. The time when the instance was created.
+  },
+  "name": "A String", # Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
+  "resource": "A String", # Required. Immutable. Resource name of workload on which the backup plan is applied. The format can either be the resource name (e.g., "projects/my-project/zones/us-central1-a/instances/my-instance") or the full resource URI (e.g., "https://www.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances/my-instance").
+  "resourceType": "A String", # Required. Immutable. Resource type of workload on which backupplan is applied
+  "rulesConfigInfo": [ # Output only. The config info related to backup rules.
+    { # Message for rules config info.
+      "lastBackupError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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. google.rpc.Status object to store the last backup 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.
+      },
+      "lastBackupState": "A String", # Output only. The last backup state for rule.
+      "lastSuccessfulBackupConsistencyTime": "A String", # Output only. The point in time when the last successful backup was captured from the source.
+      "ruleId": "A String", # Output only. Backup Rule id fetched from backup plan.
+    },
+  ],
+  "state": "A String", # Output only. The BackupPlanAssociation resource state.
+  "updateTime": "A String", # Output only. The time when the instance was updated.
+}
+
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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 t he 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, Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlanAssociation 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 the request will fail. Currently backup_plan_association.backup_plan is the only supported field.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ triggerBackup(name, body=None, x__xgafv=None) +
Triggers a new Backup.
+
+Args:
+  name: string, Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for triggering a backup.
+  "customRetentionDays": 42, # Optional. The duration for which backup data will be kept, while taking an on-demand backup with custom retention. It is defined in "days". It is mutually exclusive with rule_id. This field is required if rule_id is not provided.
+  "labels": { # Optional. Labels to be applied on the backup.
+    "a_key": "A String",
+  },
+  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  "ruleId": "A String", # Optional. backup rule_id for which a backup needs to be triggered. If not specified, on-demand backup with custom retention will be triggered.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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/backupdr_v1beta.projects.locations.backupPlans.html b/docs/dyn/backupdr_v1beta.projects.locations.backupPlans.html new file mode 100644 index 0000000000..af82b793ce --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.locations.backupPlans.html @@ -0,0 +1,505 @@ + + + +

Backup and DR Service API . projects . locations . backupPlans

+

Instance Methods

+

+ revisions() +

+

Returns the revisions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Create a BackupPlan

+

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

+

Deletes a single BackupPlan.

+

+ get(name, x__xgafv=None)

+

Gets details of a single BackupPlan.

+

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

+

Lists BackupPlans in a given project and location.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Update a BackupPlan.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, backupPlanId=None, body=None, requestId=None, x__xgafv=None) +
Create a BackupPlan
+
+Args:
+  parent: string, Required. The `BackupPlan` project and location in the format `projects/{project}/locations/{location}`. In Google Cloud Backup and DR locations map to Google Cloud regions, for example **us-central1**. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads.
+  "backupRules": [ # Optional. The backup rules for this `BackupPlan`.
+    { # `BackupRule` binds the backup schedule to a retention policy.
+      "backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules. Note: Longer retention can lead to higher storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.
+      "ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
+      "standardSchedule": { # `StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY. # Optional. Defines a schedule that runs within the confines of a defined window of time.
+        "backupWindow": { # `BackupWindow` defines a window of the day during which backup jobs will run. # Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window.
+          "endHourOfDay": 42, # Required. The hour of day (1-24) when the window end for e.g. if value of end hour of day is 10 that mean backup window end time is 10:00. End hour of day should be greater than start hour of day. 0 <= start_hour_of_day < end_hour_of_day <= 24 End hour of day is not include in backup window that mean if end_hour_of_day= 10 jobs should start before 10:00.
+          "startHourOfDay": 42, # Required. The hour of day (0-23) when the window starts for e.g. if value of start hour of day is 6 that mean backup window start at 6:00.
+        },
+        "daysOfMonth": [ # Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values for `days_of_month` are only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+          42,
+        ],
+        "daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`.
+          "A String",
+        ],
+        "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 1-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details.
+        "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied.
+          "A String",
+        ],
+        "recurrenceType": "A String", # Required. Specifies the `RecurrenceType` for the schedule.
+        "timeZone": "A String", # Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.
+        "weekDayOfMonth": { # `WeekDayOfMonth` defines the week day of the month on which the backups will run. The message combines a `WeekOfMonth` and `DayOfWeek` to produce values like `FIRST`/`MONDAY` or `LAST`/`FRIDAY`. # Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, e.g. `LAST`. This field is only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+          "dayOfWeek": "A String", # Required. Specifies the day of the week.
+          "weekOfMonth": "A String", # Required. Specifies the week of the month.
+        },
+      },
+    },
+  ],
+  "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
+  "backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.
+  "computeInstanceBackupPlanProperties": { # Properties for a compute instance backup plan. # Optional. Defines optional properties specific to backups of compute instance based resources, such as Compute Engine Instances. This includes settings like whether to perform a guest flush.
+    "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false.
+  },
+  "createTime": "A String", # Output only. When the `BackupPlan` was created.
+  "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.
+  "diskBackupPlanProperties": { # Properties for a disk backup plan. # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush.
+    "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a disk backup. When set to false, the system will create crash-consistent backups. Default value is false.
+  },
+  "etag": "A String", # Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.
+  "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.
+    "a_key": "A String",
+  },
+  "logRetentionDays": "A String", # Optional. Applicable only for Cloud SQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.
+  "maxCustomOnDemandRetentionDays": 42, # Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.
+  "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
+  "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".
+  "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+  "revisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`
+  "state": "A String", # Output only. The `State` for the `BackupPlan`.
+  "supportedResourceTypes": [ # Output only. All resource types to which backupPlan can be applied.
+    "A String",
+  ],
+  "updateTime": "A String", # Output only. When the `BackupPlan` was last updated.
+}
+
+  backupPlanId: string, Required. The name of the `BackupPlan` to create. The name must be unique for the specified project and location.The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
+  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 t he 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:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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 single BackupPlan.
+
+Args:
+  name: string, Required. The resource name of the `BackupPlan` to delete. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` (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:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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 BackupPlan.
+
+Args:
+  name: string, Required. The resource name of the `BackupPlan` to retrieve. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads.
+  "backupRules": [ # Optional. The backup rules for this `BackupPlan`.
+    { # `BackupRule` binds the backup schedule to a retention policy.
+      "backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules. Note: Longer retention can lead to higher storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.
+      "ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
+      "standardSchedule": { # `StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY. # Optional. Defines a schedule that runs within the confines of a defined window of time.
+        "backupWindow": { # `BackupWindow` defines a window of the day during which backup jobs will run. # Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window.
+          "endHourOfDay": 42, # Required. The hour of day (1-24) when the window end for e.g. if value of end hour of day is 10 that mean backup window end time is 10:00. End hour of day should be greater than start hour of day. 0 <= start_hour_of_day < end_hour_of_day <= 24 End hour of day is not include in backup window that mean if end_hour_of_day= 10 jobs should start before 10:00.
+          "startHourOfDay": 42, # Required. The hour of day (0-23) when the window starts for e.g. if value of start hour of day is 6 that mean backup window start at 6:00.
+        },
+        "daysOfMonth": [ # Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values for `days_of_month` are only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+          42,
+        ],
+        "daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`.
+          "A String",
+        ],
+        "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 1-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details.
+        "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied.
+          "A String",
+        ],
+        "recurrenceType": "A String", # Required. Specifies the `RecurrenceType` for the schedule.
+        "timeZone": "A String", # Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.
+        "weekDayOfMonth": { # `WeekDayOfMonth` defines the week day of the month on which the backups will run. The message combines a `WeekOfMonth` and `DayOfWeek` to produce values like `FIRST`/`MONDAY` or `LAST`/`FRIDAY`. # Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, e.g. `LAST`. This field is only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+          "dayOfWeek": "A String", # Required. Specifies the day of the week.
+          "weekOfMonth": "A String", # Required. Specifies the week of the month.
+        },
+      },
+    },
+  ],
+  "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
+  "backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.
+  "computeInstanceBackupPlanProperties": { # Properties for a compute instance backup plan. # Optional. Defines optional properties specific to backups of compute instance based resources, such as Compute Engine Instances. This includes settings like whether to perform a guest flush.
+    "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false.
+  },
+  "createTime": "A String", # Output only. When the `BackupPlan` was created.
+  "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.
+  "diskBackupPlanProperties": { # Properties for a disk backup plan. # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush.
+    "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a disk backup. When set to false, the system will create crash-consistent backups. Default value is false.
+  },
+  "etag": "A String", # Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.
+  "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.
+    "a_key": "A String",
+  },
+  "logRetentionDays": "A String", # Optional. Applicable only for Cloud SQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.
+  "maxCustomOnDemandRetentionDays": 42, # Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.
+  "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
+  "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".
+  "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+  "revisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`
+  "state": "A String", # Output only. The `State` for the `BackupPlan`.
+  "supportedResourceTypes": [ # Output only. All resource types to which backupPlan can be applied.
+    "A String",
+  ],
+  "updateTime": "A String", # Output only. When the `BackupPlan` was last updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists BackupPlans in a given project and location.
+
+Args:
+  parent: string, Required. The project and location for which to retrieve `BackupPlans` information. Format: `projects/{project}/locations/{location}`. In Google Cloud Backup and DR, locations map to Google Cloud regions, for e.g. **us-central1**. To retrieve backup plans for all locations, use "-" for the `{location}` value. (required)
+  filter: string, Optional. Field match expression used to filter the results.
+  orderBy: string, Optional. Field by which to sort the results.
+  pageSize: integer, Optional. The maximum number of `BackupPlans` to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
+  pageToken: string, Optional. The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlans` 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:
+
+    { # The response message for getting a list of `BackupPlan`.
+  "backupPlans": [ # The list of `BackupPlans` in the project for the specified location. If the `{location}` value in the request is "-", the response contains a list of resources from all locations. In case any location is unreachable, the response will only return backup plans in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. BackupPlan
+    { # A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads.
+      "backupRules": [ # Optional. The backup rules for this `BackupPlan`.
+        { # `BackupRule` binds the backup schedule to a retention policy.
+          "backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules. Note: Longer retention can lead to higher storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.
+          "ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
+          "standardSchedule": { # `StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY. # Optional. Defines a schedule that runs within the confines of a defined window of time.
+            "backupWindow": { # `BackupWindow` defines a window of the day during which backup jobs will run. # Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window.
+              "endHourOfDay": 42, # Required. The hour of day (1-24) when the window end for e.g. if value of end hour of day is 10 that mean backup window end time is 10:00. End hour of day should be greater than start hour of day. 0 <= start_hour_of_day < end_hour_of_day <= 24 End hour of day is not include in backup window that mean if end_hour_of_day= 10 jobs should start before 10:00.
+              "startHourOfDay": 42, # Required. The hour of day (0-23) when the window starts for e.g. if value of start hour of day is 6 that mean backup window start at 6:00.
+            },
+            "daysOfMonth": [ # Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values for `days_of_month` are only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+              42,
+            ],
+            "daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`.
+              "A String",
+            ],
+            "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 1-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details.
+            "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied.
+              "A String",
+            ],
+            "recurrenceType": "A String", # Required. Specifies the `RecurrenceType` for the schedule.
+            "timeZone": "A String", # Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.
+            "weekDayOfMonth": { # `WeekDayOfMonth` defines the week day of the month on which the backups will run. The message combines a `WeekOfMonth` and `DayOfWeek` to produce values like `FIRST`/`MONDAY` or `LAST`/`FRIDAY`. # Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, e.g. `LAST`. This field is only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+              "dayOfWeek": "A String", # Required. Specifies the day of the week.
+              "weekOfMonth": "A String", # Required. Specifies the week of the month.
+            },
+          },
+        },
+      ],
+      "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
+      "backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.
+      "computeInstanceBackupPlanProperties": { # Properties for a compute instance backup plan. # Optional. Defines optional properties specific to backups of compute instance based resources, such as Compute Engine Instances. This includes settings like whether to perform a guest flush.
+        "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false.
+      },
+      "createTime": "A String", # Output only. When the `BackupPlan` was created.
+      "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.
+      "diskBackupPlanProperties": { # Properties for a disk backup plan. # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush.
+        "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a disk backup. When set to false, the system will create crash-consistent backups. Default value is false.
+      },
+      "etag": "A String", # Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.
+      "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.
+        "a_key": "A String",
+      },
+      "logRetentionDays": "A String", # Optional. Applicable only for Cloud SQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.
+      "maxCustomOnDemandRetentionDays": 42, # Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.
+      "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
+      "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".
+      "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+      "revisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`
+      "state": "A String", # Output only. The `State` for the `BackupPlan`.
+      "supportedResourceTypes": [ # Output only. All resource types to which backupPlan can be applied.
+        "A String",
+      ],
+      "updateTime": "A String", # Output only. When the `BackupPlan` was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token which may be sent as page_token in a subsequent `ListBackupPlans` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Update a BackupPlan.
+
+Args:
+  name: string, Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads.
+  "backupRules": [ # Optional. The backup rules for this `BackupPlan`.
+    { # `BackupRule` binds the backup schedule to a retention policy.
+      "backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules. Note: Longer retention can lead to higher storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.
+      "ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
+      "standardSchedule": { # `StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY. # Optional. Defines a schedule that runs within the confines of a defined window of time.
+        "backupWindow": { # `BackupWindow` defines a window of the day during which backup jobs will run. # Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window.
+          "endHourOfDay": 42, # Required. The hour of day (1-24) when the window end for e.g. if value of end hour of day is 10 that mean backup window end time is 10:00. End hour of day should be greater than start hour of day. 0 <= start_hour_of_day < end_hour_of_day <= 24 End hour of day is not include in backup window that mean if end_hour_of_day= 10 jobs should start before 10:00.
+          "startHourOfDay": 42, # Required. The hour of day (0-23) when the window starts for e.g. if value of start hour of day is 6 that mean backup window start at 6:00.
+        },
+        "daysOfMonth": [ # Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values for `days_of_month` are only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+          42,
+        ],
+        "daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`.
+          "A String",
+        ],
+        "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 1-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details.
+        "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied.
+          "A String",
+        ],
+        "recurrenceType": "A String", # Required. Specifies the `RecurrenceType` for the schedule.
+        "timeZone": "A String", # Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.
+        "weekDayOfMonth": { # `WeekDayOfMonth` defines the week day of the month on which the backups will run. The message combines a `WeekOfMonth` and `DayOfWeek` to produce values like `FIRST`/`MONDAY` or `LAST`/`FRIDAY`. # Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, e.g. `LAST`. This field is only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+          "dayOfWeek": "A String", # Required. Specifies the day of the week.
+          "weekOfMonth": "A String", # Required. Specifies the week of the month.
+        },
+      },
+    },
+  ],
+  "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
+  "backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.
+  "computeInstanceBackupPlanProperties": { # Properties for a compute instance backup plan. # Optional. Defines optional properties specific to backups of compute instance based resources, such as Compute Engine Instances. This includes settings like whether to perform a guest flush.
+    "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false.
+  },
+  "createTime": "A String", # Output only. When the `BackupPlan` was created.
+  "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.
+  "diskBackupPlanProperties": { # Properties for a disk backup plan. # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush.
+    "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a disk backup. When set to false, the system will create crash-consistent backups. Default value is false.
+  },
+  "etag": "A String", # Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.
+  "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.
+    "a_key": "A String",
+  },
+  "logRetentionDays": "A String", # Optional. Applicable only for Cloud SQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.
+  "maxCustomOnDemandRetentionDays": 42, # Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.
+  "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
+  "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".
+  "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+  "revisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`
+  "state": "A String", # Output only. The `State` for the `BackupPlan`.
+  "supportedResourceTypes": [ # Output only. All resource types to which backupPlan can be applied.
+    "A String",
+  ],
+  "updateTime": "A String", # Output only. When the `BackupPlan` was last updated.
+}
+
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server 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 t he 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, Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan 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 the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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/backupdr_v1beta.projects.locations.backupPlans.revisions.html b/docs/dyn/backupdr_v1beta.projects.locations.backupPlans.revisions.html new file mode 100644 index 0000000000..9d67f24e58 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.locations.backupPlans.revisions.html @@ -0,0 +1,273 @@ + + + +

Backup and DR Service API . projects . locations . backupPlans . revisions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details of a single BackupPlanRevision.

+

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

+

Lists BackupPlanRevisions in a given project and location.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single BackupPlanRevision.
+
+Args:
+  name: string, Required. The resource name of the `BackupPlanRevision` to retrieve. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/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:
+
+    { # `BackupPlanRevision` represents a snapshot of a `BackupPlan` at a point in time.
+  "backupPlanSnapshot": { # A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads. # The Backup Plan being encompassed by this revision.
+    "backupRules": [ # Optional. The backup rules for this `BackupPlan`.
+      { # `BackupRule` binds the backup schedule to a retention policy.
+        "backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules. Note: Longer retention can lead to higher storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.
+        "ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
+        "standardSchedule": { # `StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY. # Optional. Defines a schedule that runs within the confines of a defined window of time.
+          "backupWindow": { # `BackupWindow` defines a window of the day during which backup jobs will run. # Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window.
+            "endHourOfDay": 42, # Required. The hour of day (1-24) when the window end for e.g. if value of end hour of day is 10 that mean backup window end time is 10:00. End hour of day should be greater than start hour of day. 0 <= start_hour_of_day < end_hour_of_day <= 24 End hour of day is not include in backup window that mean if end_hour_of_day= 10 jobs should start before 10:00.
+            "startHourOfDay": 42, # Required. The hour of day (0-23) when the window starts for e.g. if value of start hour of day is 6 that mean backup window start at 6:00.
+          },
+          "daysOfMonth": [ # Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values for `days_of_month` are only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+            42,
+          ],
+          "daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`.
+            "A String",
+          ],
+          "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 1-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details.
+          "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied.
+            "A String",
+          ],
+          "recurrenceType": "A String", # Required. Specifies the `RecurrenceType` for the schedule.
+          "timeZone": "A String", # Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.
+          "weekDayOfMonth": { # `WeekDayOfMonth` defines the week day of the month on which the backups will run. The message combines a `WeekOfMonth` and `DayOfWeek` to produce values like `FIRST`/`MONDAY` or `LAST`/`FRIDAY`. # Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, e.g. `LAST`. This field is only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+            "dayOfWeek": "A String", # Required. Specifies the day of the week.
+            "weekOfMonth": "A String", # Required. Specifies the week of the month.
+          },
+        },
+      },
+    ],
+    "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
+    "backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.
+    "computeInstanceBackupPlanProperties": { # Properties for a compute instance backup plan. # Optional. Defines optional properties specific to backups of compute instance based resources, such as Compute Engine Instances. This includes settings like whether to perform a guest flush.
+      "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false.
+    },
+    "createTime": "A String", # Output only. When the `BackupPlan` was created.
+    "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.
+    "diskBackupPlanProperties": { # Properties for a disk backup plan. # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush.
+      "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a disk backup. When set to false, the system will create crash-consistent backups. Default value is false.
+    },
+    "etag": "A String", # Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.
+    "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.
+      "a_key": "A String",
+    },
+    "logRetentionDays": "A String", # Optional. Applicable only for Cloud SQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.
+    "maxCustomOnDemandRetentionDays": 42, # Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.
+    "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
+    "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".
+    "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+    "revisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`
+    "state": "A String", # Output only. The `State` for the `BackupPlan`.
+    "supportedResourceTypes": [ # Output only. All resource types to which backupPlan can be applied.
+      "A String",
+    ],
+    "updateTime": "A String", # Output only. When the `BackupPlan` was last updated.
+  },
+  "createTime": "A String", # Output only. The timestamp that the revision was created.
+  "name": "A String", # Output only. Identifier. The resource name of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision}`
+  "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+  "state": "A String", # Output only. Resource State
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists BackupPlanRevisions in a given project and location.
+
+Args:
+  parent: string, Required. The project and location for which to retrieve `BackupPlanRevisions` information. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`. In Google Cloud Backup and DR, locations map to Google Cloud regions, for e.g. **us-central1**. (required)
+  pageSize: integer, Optional. The maximum number of `BackupPlans` to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
+  pageToken: string, Optional. The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlans` 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:
+
+    { # The response message for getting a list of `BackupPlanRevision`.
+  "backupPlanRevisions": [ # The list of `BackupPlanRevisions` in the project for the specified location. If the `{location}` value in the request is "-", the response contains a list of resources from all locations. In case any location is unreachable, the response will only return backup plans in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.
+    { # `BackupPlanRevision` represents a snapshot of a `BackupPlan` at a point in time.
+      "backupPlanSnapshot": { # A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads. # The Backup Plan being encompassed by this revision.
+        "backupRules": [ # Optional. The backup rules for this `BackupPlan`.
+          { # `BackupRule` binds the backup schedule to a retention policy.
+            "backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules. Note: Longer retention can lead to higher storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.
+            "ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
+            "standardSchedule": { # `StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY. # Optional. Defines a schedule that runs within the confines of a defined window of time.
+              "backupWindow": { # `BackupWindow` defines a window of the day during which backup jobs will run. # Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window.
+                "endHourOfDay": 42, # Required. The hour of day (1-24) when the window end for e.g. if value of end hour of day is 10 that mean backup window end time is 10:00. End hour of day should be greater than start hour of day. 0 <= start_hour_of_day < end_hour_of_day <= 24 End hour of day is not include in backup window that mean if end_hour_of_day= 10 jobs should start before 10:00.
+                "startHourOfDay": 42, # Required. The hour of day (0-23) when the window starts for e.g. if value of start hour of day is 6 that mean backup window start at 6:00.
+              },
+              "daysOfMonth": [ # Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values for `days_of_month` are only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+                42,
+              ],
+              "daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`.
+                "A String",
+              ],
+              "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 1-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details.
+              "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied.
+                "A String",
+              ],
+              "recurrenceType": "A String", # Required. Specifies the `RecurrenceType` for the schedule.
+              "timeZone": "A String", # Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.
+              "weekDayOfMonth": { # `WeekDayOfMonth` defines the week day of the month on which the backups will run. The message combines a `WeekOfMonth` and `DayOfWeek` to produce values like `FIRST`/`MONDAY` or `LAST`/`FRIDAY`. # Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, e.g. `LAST`. This field is only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.
+                "dayOfWeek": "A String", # Required. Specifies the day of the week.
+                "weekOfMonth": "A String", # Required. Specifies the week of the month.
+              },
+            },
+          },
+        ],
+        "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
+        "backupVaultServiceAccount": "A String", # Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.
+        "computeInstanceBackupPlanProperties": { # Properties for a compute instance backup plan. # Optional. Defines optional properties specific to backups of compute instance based resources, such as Compute Engine Instances. This includes settings like whether to perform a guest flush.
+          "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false.
+        },
+        "createTime": "A String", # Output only. When the `BackupPlan` was created.
+        "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.
+        "diskBackupPlanProperties": { # Properties for a disk backup plan. # Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush.
+          "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a disk backup. When set to false, the system will create crash-consistent backups. Default value is false.
+        },
+        "etag": "A String", # Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.
+        "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.
+          "a_key": "A String",
+        },
+        "logRetentionDays": "A String", # Optional. Applicable only for Cloud SQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.
+        "maxCustomOnDemandRetentionDays": 42, # Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.
+        "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
+        "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".
+        "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+        "revisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`
+        "state": "A String", # Output only. The `State` for the `BackupPlan`.
+        "supportedResourceTypes": [ # Output only. All resource types to which backupPlan can be applied.
+          "A String",
+        ],
+        "updateTime": "A String", # Output only. When the `BackupPlan` was last updated.
+      },
+      "createTime": "A String", # Output only. The timestamp that the revision was created.
+      "name": "A String", # Output only. Identifier. The resource name of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision}`
+      "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
+      "state": "A String", # Output only. Resource State
+    },
+  ],
+  "nextPageToken": "A String", # A token which may be sent as page_token in a subsequent `ListBackupPlanRevisions` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1beta.projects.locations.backupVaults.dataSources.backups.html b/docs/dyn/backupdr_v1beta.projects.locations.backupVaults.dataSources.backups.html new file mode 100644 index 0000000000..0377314ce6 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.locations.backupVaults.dataSources.backups.html @@ -0,0 +1,1621 @@ + + + +

Backup and DR Service API . projects . locations . backupVaults . dataSources . backups

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Deletes a Backup.

+

+ fetchForResourceType(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, resourceType=None, view=None, x__xgafv=None)

+

Fetch Backups for a given resource type.

+

+ fetchForResourceType_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Gets details of a Backup.

+

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

+

Lists Backups in a given project and location.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates the settings of a Backup.

+

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

+

Restore from a Backup

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, requestId=None, x__xgafv=None) +
Deletes a Backup.
+
+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:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ fetchForResourceType(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, resourceType=None, view=None, x__xgafv=None) +
Fetch Backups for a given resource type.
+
+Args:
+  parent: string, Required. Datasources are the parent resource for the backups. Format: projects/{project}/locations/{location}/backupVaults/{backupVaultId}/dataSources/{datasourceId} (required)
+  filter: string, Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields: * name * state * backup_type * create_time * expire_time * enforced_retention_end_time * gcp_backup_plan_info.backup_plan * cloud_sql_instance_backup_properties.instance_tier * cloud_sql_instance_backup_properties.database_installed_version
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * name
+  pageSize: integer, Optional. The maximum number of Backups to return. The service may return fewer than this value. If unspecified, at most 50 Backups will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+  pageToken: string, Optional. A page token, received from a previous call of `FetchBackupsForResourceType`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchBackupsForResourceType` must match the call that provided the page token.
+  resourceType: string, Required. The type of the GCP resource. Ex: sqladmin.googleapis.com/Instance
+  view: string, Optional. This parameter is used to specify the view of the backup. If not specified, the default view is BASIC.
+    Allowed values
+      BACKUP_VIEW_UNSPECIFIED - If the value is not set, the default 'FULL' view is used.
+      BACKUP_VIEW_BASIC - Includes basic data about the Backup, but not the full contents.
+      BACKUP_VIEW_FULL - Includes all data about the Backup. This is the default value (for both ListBackups and GetBackup).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the FetchBackupsForResourceType method.
+  "backups": [ # The Backups from the specified parent.
+    { # Message describing a Backup object.
+      "alloyDbBackupProperties": { # AlloyDbClusterBackupProperties represents AlloyDB cluster backup properties. . # Output only. AlloyDB specific backup properties.
+        "chainId": "A String", # Output only. The chain id of this backup. Backups belonging to the same chain are sharing the same chain id. This property is calculated and maintained by BackupDR.
+        "databaseVersion": "A String", # Output only. The PostgreSQL major version of the AlloyDB cluster when the backup was taken.
+        "description": "A String", # An optional text description for the backup.
+        "storedBytes": "A String", # Output only. Storage usage of this particular backup
+      },
+      "backupApplianceBackupProperties": { # BackupApplianceBackupProperties represents BackupDR backup appliance's properties. # Output only. Backup Appliance specific backup properties.
+        "finalizeTime": "A String", # Output only. The time when this backup object was finalized (if none, backup is not finalized).
+        "generationId": 42, # Output only. The numeric generation ID of the backup (monotonically increasing).
+        "recoveryRangeEndTime": "A String", # Optional. The latest timestamp of data available in this Backup.
+        "recoveryRangeStartTime": "A String", # Optional. The earliest timestamp of data available in this Backup.
+      },
+      "backupApplianceLocks": [ # Optional. The list of BackupLocks taken by the accessor Backup Appliance.
+        { # BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.
+          "backupApplianceLockInfo": { # BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. # If the client is a backup and recovery appliance, this contains metadata about why the lock exists.
+            "backupApplianceId": "A String", # Required. The ID of the backup/recovery appliance that created this lock.
+            "backupApplianceName": "A String", # Required. The name of the backup/recovery appliance that created this lock.
+            "backupImage": "A String", # The image name that depends on this Backup.
+            "jobName": "A String", # The job name on the backup/recovery appliance that created this lock.
+            "lockReason": "A String", # Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service.
+            "slaId": "A String", # The SLA on the backup/recovery appliance that owns the lock.
+          },
+          "lockUntilTime": "A String", # Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion.
+          "serviceLockInfo": { # ServiceLockInfo represents the details of a lock taken by the service on a Backup resource. # Output only. Contains metadata about the lock exist for Google Cloud native backups.
+            "operation": "A String", # Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes.
+          },
+        },
+      ],
+      "backupRetentionInheritance": "A String", # Output only. Setting for how the enforced retention end time is inherited. This value is copied from this backup's BackupVault.
+      "backupType": "A String", # Output only. Type of the backup, unspecified, scheduled or ondemand.
+      "cloudSqlInstanceBackupProperties": { # CloudSqlInstanceBackupProperties represents Cloud SQL Instance Backup properties. # Output only. Cloud SQL specific backup properties.
+        "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance when the backup was taken.
+        "finalBackup": True or False, # Output only. Whether the backup is a final backup.
+        "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+        "instanceDeleteTime": "A String", # Output only. The instance delete timestamp.
+        "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`
+        "sourceInstance": "A String", # Output only. The source instance of the backup. Format: projects/{project}/instances/{instance}
+      },
+      "computeInstanceBackupProperties": { # ComputeInstanceBackupProperties represents Compute Engine instance backup properties. # Output only. Compute Engine specific backup properties.
+        "canIpForward": True or False, # Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify `true`. If unsure, leave this set to `false`. See the https://cloud.google.com/vpc/docs/using-routes#canipforward documentation for more information.
+        "description": "A String", # An optional text description for the instances that are created from these properties.
+        "disk": [ # An array of disks that are associated with the instances that are created from these properties.
+          { # An instance-attached disk resource.
+            "autoDelete": True or False, # Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+            "deviceName": "A String", # Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like disk_name and replica_zones (in case of RePDs)
+            "diskEncryptionKey": { # A customer-supplied encryption key. # Optional. Encrypts or decrypts a disk using a customer-supplied encryption key.
+              "kmsKeyName": "A String", # Optional. The name of the encryption key that is stored in Google Cloud KMS.
+              "kmsKeyServiceAccount": "A String", # Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
+              "rawKey": "A String", # Optional. Specifies a 256-bit customer-supplied encryption key.
+              "rsaEncryptedKey": "A String", # Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+            },
+            "diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk.
+            "diskSizeGb": "A String", # Optional. The size of the disk in GB.
+            "diskType": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd
+            "diskTypeDeprecated": "A String", # Specifies the type of the disk.
+            "guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images.
+              { # Feature type of the Guest OS.
+                "type": "A String", # The ID of a supported feature.
+              },
+            ],
+            "index": "A String", # Optional. A zero-based index to this disk, where 0 is reserved for the boot disk.
+            "initializeParams": { # Specifies the parameters to initialize this disk. # Optional. Specifies the parameters to initialize this disk.
+              "diskName": "A String", # Optional. Specifies the disk name. If not specified, the default is to use the name of the instance.
+              "replicaZones": [ # Optional. URL of the zone where the disk should be created. Required for each regional disk associated with the instance.
+                "A String",
+              ],
+            },
+            "kind": "A String", # Optional. Type of the resource.
+            "license": [ # Optional. Any valid publicly visible licenses.
+              "A String",
+            ],
+            "mode": "A String", # Optional. The mode in which to attach this disk.
+            "savedState": "A String", # Optional. Output only. The state of the disk.
+            "source": "A String", # Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource.
+            "type": "A String", # Optional. Specifies the type of the disk.
+          },
+        ],
+        "guestAccelerator": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.
+          { # A specification of the type and number of accelerator cards attached to the instance.
+            "acceleratorCount": 42, # Optional. The number of the guest accelerator cards exposed to this instance.
+            "acceleratorType": "A String", # Optional. Full or partial URL of the accelerator type resource to attach to this instance.
+          },
+        ],
+        "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false.
+        "keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
+        "labels": { # Labels to apply to instances that are created from these properties.
+          "a_key": "A String",
+        },
+        "machineType": "A String", # The machine type to use for instances that are created from these properties.
+        "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information.
+          "items": [ # Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
+            { # A key/value pair to be used for storing metadata.
+              "key": "A String", # Optional. Key for the metadata entry.
+              "value": "A String", # Optional. Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
+            },
+          ],
+        },
+        "minCpuPlatform": "A String", # Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: Intel Haswell` or `minCpuPlatform: Intel Sandy Bridge`. For more information, read https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
+        "networkInterface": [ # An array of network access configurations for this interface.
+          { # A network interface resource attached to an instance. s
+            "accessConfigs": [ # Optional. An array of configurations for this interface. Currently, only one access config,ONE_TO_ONE_NAT is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+              { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+                "externalIpv6": "A String", # Optional. The external IPv6 address of this access configuration.
+                "externalIpv6PrefixLength": 42, # Optional. The prefix length of the external IPv6 range.
+                "name": "A String", # Optional. The name of this access configuration.
+                "natIP": "A String", # Optional. The external IP address of this access configuration.
+                "networkTier": "A String", # Optional. This signifies the networking tier used for configuring this access
+                "publicPtrDomainName": "A String", # Optional. The DNS domain name for the public PTR record.
+                "setPublicPtr": True or False, # Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
+                "type": "A String", # Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
+              },
+            ],
+            "aliasIpRanges": [ # Optional. An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
+              { # An alias IP range attached to an instance's network interface.
+                "ipCidrRange": "A String", # Optional. The IP alias ranges to allocate for this interface.
+                "subnetworkRangeName": "A String", # Optional. The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.
+              },
+            ],
+            "internalIpv6PrefixLength": 42, # Optional. The prefix length of the primary internal IPv6 range.
+            "ipv6AccessConfigs": [ # Optional. An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.
+              { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+                "externalIpv6": "A String", # Optional. The external IPv6 address of this access configuration.
+                "externalIpv6PrefixLength": 42, # Optional. The prefix length of the external IPv6 range.
+                "name": "A String", # Optional. The name of this access configuration.
+                "natIP": "A String", # Optional. The external IP address of this access configuration.
+                "networkTier": "A String", # Optional. This signifies the networking tier used for configuring this access
+                "publicPtrDomainName": "A String", # Optional. The DNS domain name for the public PTR record.
+                "setPublicPtr": True or False, # Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
+                "type": "A String", # Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
+              },
+            ],
+            "ipv6AccessType": "A String", # Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.
+            "ipv6Address": "A String", # Optional. An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.
+            "name": "A String", # Output only. [Output Only] The name of the network interface, which is generated by the server.
+            "network": "A String", # Optional. URL of the VPC network resource for this instance.
+            "networkAttachment": "A String", # Optional. The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
+            "networkIP": "A String", # Optional. An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+            "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
+            "queueCount": 42, # Optional. The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.
+            "stackType": "A String", # The stack type for this network interface.
+            "subnetwork": "A String", # Optional. The URL of the Subnetwork resource for this instance.
+          },
+        ],
+        "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties.
+          "automaticRestart": True or False, # Optional. Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
+          "instanceTerminationAction": "A String", # Optional. Specifies the termination action for the instance.
+          "localSsdRecoveryTimeout": { # A SchedulingDuration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Optional. Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour.
+            "nanos": 42, # Optional. Span of time that's a fraction of a second at nanosecond resolution.
+            "seconds": "A String", # Optional. Span of time at a resolution of a second.
+          },
+          "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
+          "nodeAffinities": [ # Optional. A set of node affinity and anti-affinity configurations. Overrides reservationAffinity.
+            { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
+              "key": "A String", # Optional. Corresponds to the label key of Node resource.
+              "operator": "A String", # Optional. Defines the operation of node selection.
+              "values": [ # Optional. Corresponds to the label values of Node resource.
+                "A String",
+              ],
+            },
+          ],
+          "onHostMaintenance": "A String", # Optional. Defines the maintenance behavior for this instance.
+          "preemptible": True or False, # Optional. Defines whether the instance is preemptible.
+          "provisioningModel": "A String", # Optional. Specifies the provisioning model of the instance.
+        },
+        "serviceAccount": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.
+          { # A service account.
+            "email": "A String", # Optional. Email address of the service account.
+            "scopes": [ # Optional. The list of scopes to be made available for this service account.
+              "A String",
+            ],
+          },
+        ],
+        "sourceInstance": "A String", # The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance
+        "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt).
+          "items": [ # Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+            "A String",
+          ],
+        },
+      },
+      "consistencyTime": "A String", # Output only. The point in time when this backup was captured from the source.
+      "createTime": "A String", # Output only. The time when the instance was created.
+      "description": "A String", # Output only. The description of the Backup instance (2048 characters or less).
+      "diskBackupProperties": { # DiskBackupProperties represents the properties of a Disk backup. # Output only. Disk specific backup properties.
+        "accessMode": "A String", # The access mode of the source disk.
+        "architecture": "A String", # The architecture of the source disk. Valid values are ARM64 or X86_64.
+        "description": "A String", # A description of the source disk.
+        "enableConfidentialCompute": True or False, # Indicates whether the source disk is using confidential compute mode.
+        "guestFlush": True or False, # Optional. Defines if the guest flush is enabled for the source disk. Default value is false.
+        "guestOsFeature": [ # A list of guest OS features that are applicable to this backup.
+          { # Feature type of the Guest OS.
+            "type": "A String", # The ID of a supported feature.
+          },
+        ],
+        "labels": { # The labels of the source disk.
+          "a_key": "A String",
+        },
+        "licenses": [ # A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image.
+          "A String",
+        ],
+        "physicalBlockSizeBytes": "A String", # The physical block size of the source disk.
+        "provisionedIops": "A String", # The number of IOPS provisioned for the source disk.
+        "provisionedThroughput": "A String", # The number of throughput provisioned for the source disk.
+        "region": "A String", # Region and zone are mutually exclusive fields. The URL of the region of the source disk.
+        "replicaZones": [ # The URL of the Zones where the source disk should be replicated.
+          "A String",
+        ],
+        "sizeGb": "A String", # Size(in GB) of the source disk.
+        "sourceDisk": "A String", # The source disk used to create this backup.
+        "storagePool": "A String", # The storage pool of the source disk.
+        "type": "A String", # The URL of the type of the disk.
+        "zone": "A String", # The URL of the Zone where the source disk.
+      },
+      "enforcedRetentionEndTime": "A String", # Optional. The backup can not be deleted before this time.
+      "etag": "A String", # Optional. Server specified ETag to prevent updates from overwriting each other.
+      "expireTime": "A String", # Optional. When this backup is automatically expired.
+      "filestoreInstanceBackupProperties": { # FilestoreInstanceBackupProperties represents the properties of a Filestore instance that are backed up by the datasource. . # Output only. Filestore specific backup properties.
+        "sourceInstance": "A String", # Output only. The source instance of the backup.
+      },
+      "gcpBackupPlanInfo": { # GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup. # Output only. Configuration for a Google Cloud resource.
+        "backupPlan": "A String", # Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
+        "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup.
+        "backupPlanRevisionName": "A String", # Resource name of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}/revisions/{revisionId}
+        "backupPlanRuleId": "A String", # The rule id of the backup plan which triggered this backup in case of scheduled backup or used for
+      },
+      "gcpResource": { # Minimum details to identify a Google Cloud resource for a backup. # Output only. Unique identifier of the GCP resource that is being backed up.
+        "gcpResourcename": "A String", # Name of the Google Cloud resource.
+        "location": "A String", # Location of the resource: //"global"/"unspecified".
+        "type": "A String", # Type of the resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.
+      },
+      "kmsKeyVersions": [ # Optional. Output only. The list of KMS key versions used to encrypt the backup.
+        "A String",
+      ],
+      "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. Name of the backup to create. It must have the format`"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}"`. `{backup}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.
+      "resourceSizeBytes": "A String", # Output only. source resource size in bytes at the time of the backup.
+      "satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
+      "satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
+      "serviceLocks": [ # Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.
+        { # BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.
+          "backupApplianceLockInfo": { # BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. # If the client is a backup and recovery appliance, this contains metadata about why the lock exists.
+            "backupApplianceId": "A String", # Required. The ID of the backup/recovery appliance that created this lock.
+            "backupApplianceName": "A String", # Required. The name of the backup/recovery appliance that created this lock.
+            "backupImage": "A String", # The image name that depends on this Backup.
+            "jobName": "A String", # The job name on the backup/recovery appliance that created this lock.
+            "lockReason": "A String", # Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service.
+            "slaId": "A String", # The SLA on the backup/recovery appliance that owns the lock.
+          },
+          "lockUntilTime": "A String", # Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion.
+          "serviceLockInfo": { # ServiceLockInfo represents the details of a lock taken by the service on a Backup resource. # Output only. Contains metadata about the lock exist for Google Cloud native backups.
+            "operation": "A String", # Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes.
+          },
+        },
+      ],
+      "state": "A String", # Output only. The Backup resource instance state.
+      "updateTime": "A String", # Output only. The time when the instance was updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ fetchForResourceType_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ get(name, view=None, x__xgafv=None) +
Gets details of a Backup.
+
+Args:
+  name: string, Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{backupVault}/dataSources/{datasource}/backups/{backup}' (required)
+  view: string, Optional. Reserved for future use to provide a BASIC & FULL view of Backup resource.
+    Allowed values
+      BACKUP_VIEW_UNSPECIFIED - If the value is not set, the default 'FULL' view is used.
+      BACKUP_VIEW_BASIC - Includes basic data about the Backup, but not the full contents.
+      BACKUP_VIEW_FULL - Includes all data about the Backup. This is the default value (for both ListBackups and GetBackup).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing a Backup object.
+  "alloyDbBackupProperties": { # AlloyDbClusterBackupProperties represents AlloyDB cluster backup properties. . # Output only. AlloyDB specific backup properties.
+    "chainId": "A String", # Output only. The chain id of this backup. Backups belonging to the same chain are sharing the same chain id. This property is calculated and maintained by BackupDR.
+    "databaseVersion": "A String", # Output only. The PostgreSQL major version of the AlloyDB cluster when the backup was taken.
+    "description": "A String", # An optional text description for the backup.
+    "storedBytes": "A String", # Output only. Storage usage of this particular backup
+  },
+  "backupApplianceBackupProperties": { # BackupApplianceBackupProperties represents BackupDR backup appliance's properties. # Output only. Backup Appliance specific backup properties.
+    "finalizeTime": "A String", # Output only. The time when this backup object was finalized (if none, backup is not finalized).
+    "generationId": 42, # Output only. The numeric generation ID of the backup (monotonically increasing).
+    "recoveryRangeEndTime": "A String", # Optional. The latest timestamp of data available in this Backup.
+    "recoveryRangeStartTime": "A String", # Optional. The earliest timestamp of data available in this Backup.
+  },
+  "backupApplianceLocks": [ # Optional. The list of BackupLocks taken by the accessor Backup Appliance.
+    { # BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.
+      "backupApplianceLockInfo": { # BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. # If the client is a backup and recovery appliance, this contains metadata about why the lock exists.
+        "backupApplianceId": "A String", # Required. The ID of the backup/recovery appliance that created this lock.
+        "backupApplianceName": "A String", # Required. The name of the backup/recovery appliance that created this lock.
+        "backupImage": "A String", # The image name that depends on this Backup.
+        "jobName": "A String", # The job name on the backup/recovery appliance that created this lock.
+        "lockReason": "A String", # Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service.
+        "slaId": "A String", # The SLA on the backup/recovery appliance that owns the lock.
+      },
+      "lockUntilTime": "A String", # Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion.
+      "serviceLockInfo": { # ServiceLockInfo represents the details of a lock taken by the service on a Backup resource. # Output only. Contains metadata about the lock exist for Google Cloud native backups.
+        "operation": "A String", # Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes.
+      },
+    },
+  ],
+  "backupRetentionInheritance": "A String", # Output only. Setting for how the enforced retention end time is inherited. This value is copied from this backup's BackupVault.
+  "backupType": "A String", # Output only. Type of the backup, unspecified, scheduled or ondemand.
+  "cloudSqlInstanceBackupProperties": { # CloudSqlInstanceBackupProperties represents Cloud SQL Instance Backup properties. # Output only. Cloud SQL specific backup properties.
+    "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance when the backup was taken.
+    "finalBackup": True or False, # Output only. Whether the backup is a final backup.
+    "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+    "instanceDeleteTime": "A String", # Output only. The instance delete timestamp.
+    "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`
+    "sourceInstance": "A String", # Output only. The source instance of the backup. Format: projects/{project}/instances/{instance}
+  },
+  "computeInstanceBackupProperties": { # ComputeInstanceBackupProperties represents Compute Engine instance backup properties. # Output only. Compute Engine specific backup properties.
+    "canIpForward": True or False, # Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify `true`. If unsure, leave this set to `false`. See the https://cloud.google.com/vpc/docs/using-routes#canipforward documentation for more information.
+    "description": "A String", # An optional text description for the instances that are created from these properties.
+    "disk": [ # An array of disks that are associated with the instances that are created from these properties.
+      { # An instance-attached disk resource.
+        "autoDelete": True or False, # Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+        "boot": True or False, # Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+        "deviceName": "A String", # Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like disk_name and replica_zones (in case of RePDs)
+        "diskEncryptionKey": { # A customer-supplied encryption key. # Optional. Encrypts or decrypts a disk using a customer-supplied encryption key.
+          "kmsKeyName": "A String", # Optional. The name of the encryption key that is stored in Google Cloud KMS.
+          "kmsKeyServiceAccount": "A String", # Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
+          "rawKey": "A String", # Optional. Specifies a 256-bit customer-supplied encryption key.
+          "rsaEncryptedKey": "A String", # Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+        },
+        "diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk.
+        "diskSizeGb": "A String", # Optional. The size of the disk in GB.
+        "diskType": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd
+        "diskTypeDeprecated": "A String", # Specifies the type of the disk.
+        "guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images.
+          { # Feature type of the Guest OS.
+            "type": "A String", # The ID of a supported feature.
+          },
+        ],
+        "index": "A String", # Optional. A zero-based index to this disk, where 0 is reserved for the boot disk.
+        "initializeParams": { # Specifies the parameters to initialize this disk. # Optional. Specifies the parameters to initialize this disk.
+          "diskName": "A String", # Optional. Specifies the disk name. If not specified, the default is to use the name of the instance.
+          "replicaZones": [ # Optional. URL of the zone where the disk should be created. Required for each regional disk associated with the instance.
+            "A String",
+          ],
+        },
+        "kind": "A String", # Optional. Type of the resource.
+        "license": [ # Optional. Any valid publicly visible licenses.
+          "A String",
+        ],
+        "mode": "A String", # Optional. The mode in which to attach this disk.
+        "savedState": "A String", # Optional. Output only. The state of the disk.
+        "source": "A String", # Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource.
+        "type": "A String", # Optional. Specifies the type of the disk.
+      },
+    ],
+    "guestAccelerator": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.
+      { # A specification of the type and number of accelerator cards attached to the instance.
+        "acceleratorCount": 42, # Optional. The number of the guest accelerator cards exposed to this instance.
+        "acceleratorType": "A String", # Optional. Full or partial URL of the accelerator type resource to attach to this instance.
+      },
+    ],
+    "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false.
+    "keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
+    "labels": { # Labels to apply to instances that are created from these properties.
+      "a_key": "A String",
+    },
+    "machineType": "A String", # The machine type to use for instances that are created from these properties.
+    "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information.
+      "items": [ # Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
+        { # A key/value pair to be used for storing metadata.
+          "key": "A String", # Optional. Key for the metadata entry.
+          "value": "A String", # Optional. Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
+        },
+      ],
+    },
+    "minCpuPlatform": "A String", # Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: Intel Haswell` or `minCpuPlatform: Intel Sandy Bridge`. For more information, read https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
+    "networkInterface": [ # An array of network access configurations for this interface.
+      { # A network interface resource attached to an instance. s
+        "accessConfigs": [ # Optional. An array of configurations for this interface. Currently, only one access config,ONE_TO_ONE_NAT is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+          { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+            "externalIpv6": "A String", # Optional. The external IPv6 address of this access configuration.
+            "externalIpv6PrefixLength": 42, # Optional. The prefix length of the external IPv6 range.
+            "name": "A String", # Optional. The name of this access configuration.
+            "natIP": "A String", # Optional. The external IP address of this access configuration.
+            "networkTier": "A String", # Optional. This signifies the networking tier used for configuring this access
+            "publicPtrDomainName": "A String", # Optional. The DNS domain name for the public PTR record.
+            "setPublicPtr": True or False, # Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
+            "type": "A String", # Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
+          },
+        ],
+        "aliasIpRanges": [ # Optional. An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
+          { # An alias IP range attached to an instance's network interface.
+            "ipCidrRange": "A String", # Optional. The IP alias ranges to allocate for this interface.
+            "subnetworkRangeName": "A String", # Optional. The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.
+          },
+        ],
+        "internalIpv6PrefixLength": 42, # Optional. The prefix length of the primary internal IPv6 range.
+        "ipv6AccessConfigs": [ # Optional. An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.
+          { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+            "externalIpv6": "A String", # Optional. The external IPv6 address of this access configuration.
+            "externalIpv6PrefixLength": 42, # Optional. The prefix length of the external IPv6 range.
+            "name": "A String", # Optional. The name of this access configuration.
+            "natIP": "A String", # Optional. The external IP address of this access configuration.
+            "networkTier": "A String", # Optional. This signifies the networking tier used for configuring this access
+            "publicPtrDomainName": "A String", # Optional. The DNS domain name for the public PTR record.
+            "setPublicPtr": True or False, # Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
+            "type": "A String", # Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
+          },
+        ],
+        "ipv6AccessType": "A String", # Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.
+        "ipv6Address": "A String", # Optional. An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.
+        "name": "A String", # Output only. [Output Only] The name of the network interface, which is generated by the server.
+        "network": "A String", # Optional. URL of the VPC network resource for this instance.
+        "networkAttachment": "A String", # Optional. The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
+        "networkIP": "A String", # Optional. An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+        "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
+        "queueCount": 42, # Optional. The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.
+        "stackType": "A String", # The stack type for this network interface.
+        "subnetwork": "A String", # Optional. The URL of the Subnetwork resource for this instance.
+      },
+    ],
+    "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties.
+      "automaticRestart": True or False, # Optional. Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
+      "instanceTerminationAction": "A String", # Optional. Specifies the termination action for the instance.
+      "localSsdRecoveryTimeout": { # A SchedulingDuration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Optional. Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour.
+        "nanos": 42, # Optional. Span of time that's a fraction of a second at nanosecond resolution.
+        "seconds": "A String", # Optional. Span of time at a resolution of a second.
+      },
+      "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
+      "nodeAffinities": [ # Optional. A set of node affinity and anti-affinity configurations. Overrides reservationAffinity.
+        { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
+          "key": "A String", # Optional. Corresponds to the label key of Node resource.
+          "operator": "A String", # Optional. Defines the operation of node selection.
+          "values": [ # Optional. Corresponds to the label values of Node resource.
+            "A String",
+          ],
+        },
+      ],
+      "onHostMaintenance": "A String", # Optional. Defines the maintenance behavior for this instance.
+      "preemptible": True or False, # Optional. Defines whether the instance is preemptible.
+      "provisioningModel": "A String", # Optional. Specifies the provisioning model of the instance.
+    },
+    "serviceAccount": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.
+      { # A service account.
+        "email": "A String", # Optional. Email address of the service account.
+        "scopes": [ # Optional. The list of scopes to be made available for this service account.
+          "A String",
+        ],
+      },
+    ],
+    "sourceInstance": "A String", # The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance
+    "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt).
+      "items": [ # Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+        "A String",
+      ],
+    },
+  },
+  "consistencyTime": "A String", # Output only. The point in time when this backup was captured from the source.
+  "createTime": "A String", # Output only. The time when the instance was created.
+  "description": "A String", # Output only. The description of the Backup instance (2048 characters or less).
+  "diskBackupProperties": { # DiskBackupProperties represents the properties of a Disk backup. # Output only. Disk specific backup properties.
+    "accessMode": "A String", # The access mode of the source disk.
+    "architecture": "A String", # The architecture of the source disk. Valid values are ARM64 or X86_64.
+    "description": "A String", # A description of the source disk.
+    "enableConfidentialCompute": True or False, # Indicates whether the source disk is using confidential compute mode.
+    "guestFlush": True or False, # Optional. Defines if the guest flush is enabled for the source disk. Default value is false.
+    "guestOsFeature": [ # A list of guest OS features that are applicable to this backup.
+      { # Feature type of the Guest OS.
+        "type": "A String", # The ID of a supported feature.
+      },
+    ],
+    "labels": { # The labels of the source disk.
+      "a_key": "A String",
+    },
+    "licenses": [ # A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image.
+      "A String",
+    ],
+    "physicalBlockSizeBytes": "A String", # The physical block size of the source disk.
+    "provisionedIops": "A String", # The number of IOPS provisioned for the source disk.
+    "provisionedThroughput": "A String", # The number of throughput provisioned for the source disk.
+    "region": "A String", # Region and zone are mutually exclusive fields. The URL of the region of the source disk.
+    "replicaZones": [ # The URL of the Zones where the source disk should be replicated.
+      "A String",
+    ],
+    "sizeGb": "A String", # Size(in GB) of the source disk.
+    "sourceDisk": "A String", # The source disk used to create this backup.
+    "storagePool": "A String", # The storage pool of the source disk.
+    "type": "A String", # The URL of the type of the disk.
+    "zone": "A String", # The URL of the Zone where the source disk.
+  },
+  "enforcedRetentionEndTime": "A String", # Optional. The backup can not be deleted before this time.
+  "etag": "A String", # Optional. Server specified ETag to prevent updates from overwriting each other.
+  "expireTime": "A String", # Optional. When this backup is automatically expired.
+  "filestoreInstanceBackupProperties": { # FilestoreInstanceBackupProperties represents the properties of a Filestore instance that are backed up by the datasource. . # Output only. Filestore specific backup properties.
+    "sourceInstance": "A String", # Output only. The source instance of the backup.
+  },
+  "gcpBackupPlanInfo": { # GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup. # Output only. Configuration for a Google Cloud resource.
+    "backupPlan": "A String", # Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
+    "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup.
+    "backupPlanRevisionName": "A String", # Resource name of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}/revisions/{revisionId}
+    "backupPlanRuleId": "A String", # The rule id of the backup plan which triggered this backup in case of scheduled backup or used for
+  },
+  "gcpResource": { # Minimum details to identify a Google Cloud resource for a backup. # Output only. Unique identifier of the GCP resource that is being backed up.
+    "gcpResourcename": "A String", # Name of the Google Cloud resource.
+    "location": "A String", # Location of the resource: //"global"/"unspecified".
+    "type": "A String", # Type of the resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.
+  },
+  "kmsKeyVersions": [ # Optional. Output only. The list of KMS key versions used to encrypt the backup.
+    "A String",
+  ],
+  "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined.
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. Identifier. Name of the backup to create. It must have the format`"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}"`. `{backup}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.
+  "resourceSizeBytes": "A String", # Output only. source resource size in bytes at the time of the backup.
+  "satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
+  "satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
+  "serviceLocks": [ # Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.
+    { # BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.
+      "backupApplianceLockInfo": { # BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. # If the client is a backup and recovery appliance, this contains metadata about why the lock exists.
+        "backupApplianceId": "A String", # Required. The ID of the backup/recovery appliance that created this lock.
+        "backupApplianceName": "A String", # Required. The name of the backup/recovery appliance that created this lock.
+        "backupImage": "A String", # The image name that depends on this Backup.
+        "jobName": "A String", # The job name on the backup/recovery appliance that created this lock.
+        "lockReason": "A String", # Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service.
+        "slaId": "A String", # The SLA on the backup/recovery appliance that owns the lock.
+      },
+      "lockUntilTime": "A String", # Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion.
+      "serviceLockInfo": { # ServiceLockInfo represents the details of a lock taken by the service on a Backup resource. # Output only. Contains metadata about the lock exist for Google Cloud native backups.
+        "operation": "A String", # Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes.
+      },
+    },
+  ],
+  "state": "A String", # Output only. The Backup resource instance state.
+  "updateTime": "A String", # Output only. The time when the instance was updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) +
Lists Backups in a given project and location.
+
+Args:
+  parent: string, Required. The project and location for which to retrieve backup information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use "-" for the '{location}' value. (required)
+  filter: string, Optional. Filtering results.
+  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.
+  view: string, Optional. Reserved for future use to provide a BASIC & FULL view of Backup resource.
+    Allowed values
+      BACKUP_VIEW_UNSPECIFIED - If the value is not set, the default 'FULL' view is used.
+      BACKUP_VIEW_BASIC - Includes basic data about the Backup, but not the full contents.
+      BACKUP_VIEW_FULL - Includes all data about the Backup. This is the default value (for both ListBackups and GetBackup).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for listing Backups.
+  "backups": [ # The list of Backup instances in the project for the specified location. If the '{location}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return data sources in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.
+    { # Message describing a Backup object.
+      "alloyDbBackupProperties": { # AlloyDbClusterBackupProperties represents AlloyDB cluster backup properties. . # Output only. AlloyDB specific backup properties.
+        "chainId": "A String", # Output only. The chain id of this backup. Backups belonging to the same chain are sharing the same chain id. This property is calculated and maintained by BackupDR.
+        "databaseVersion": "A String", # Output only. The PostgreSQL major version of the AlloyDB cluster when the backup was taken.
+        "description": "A String", # An optional text description for the backup.
+        "storedBytes": "A String", # Output only. Storage usage of this particular backup
+      },
+      "backupApplianceBackupProperties": { # BackupApplianceBackupProperties represents BackupDR backup appliance's properties. # Output only. Backup Appliance specific backup properties.
+        "finalizeTime": "A String", # Output only. The time when this backup object was finalized (if none, backup is not finalized).
+        "generationId": 42, # Output only. The numeric generation ID of the backup (monotonically increasing).
+        "recoveryRangeEndTime": "A String", # Optional. The latest timestamp of data available in this Backup.
+        "recoveryRangeStartTime": "A String", # Optional. The earliest timestamp of data available in this Backup.
+      },
+      "backupApplianceLocks": [ # Optional. The list of BackupLocks taken by the accessor Backup Appliance.
+        { # BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.
+          "backupApplianceLockInfo": { # BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. # If the client is a backup and recovery appliance, this contains metadata about why the lock exists.
+            "backupApplianceId": "A String", # Required. The ID of the backup/recovery appliance that created this lock.
+            "backupApplianceName": "A String", # Required. The name of the backup/recovery appliance that created this lock.
+            "backupImage": "A String", # The image name that depends on this Backup.
+            "jobName": "A String", # The job name on the backup/recovery appliance that created this lock.
+            "lockReason": "A String", # Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service.
+            "slaId": "A String", # The SLA on the backup/recovery appliance that owns the lock.
+          },
+          "lockUntilTime": "A String", # Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion.
+          "serviceLockInfo": { # ServiceLockInfo represents the details of a lock taken by the service on a Backup resource. # Output only. Contains metadata about the lock exist for Google Cloud native backups.
+            "operation": "A String", # Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes.
+          },
+        },
+      ],
+      "backupRetentionInheritance": "A String", # Output only. Setting for how the enforced retention end time is inherited. This value is copied from this backup's BackupVault.
+      "backupType": "A String", # Output only. Type of the backup, unspecified, scheduled or ondemand.
+      "cloudSqlInstanceBackupProperties": { # CloudSqlInstanceBackupProperties represents Cloud SQL Instance Backup properties. # Output only. Cloud SQL specific backup properties.
+        "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance when the backup was taken.
+        "finalBackup": True or False, # Output only. Whether the backup is a final backup.
+        "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+        "instanceDeleteTime": "A String", # Output only. The instance delete timestamp.
+        "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`
+        "sourceInstance": "A String", # Output only. The source instance of the backup. Format: projects/{project}/instances/{instance}
+      },
+      "computeInstanceBackupProperties": { # ComputeInstanceBackupProperties represents Compute Engine instance backup properties. # Output only. Compute Engine specific backup properties.
+        "canIpForward": True or False, # Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify `true`. If unsure, leave this set to `false`. See the https://cloud.google.com/vpc/docs/using-routes#canipforward documentation for more information.
+        "description": "A String", # An optional text description for the instances that are created from these properties.
+        "disk": [ # An array of disks that are associated with the instances that are created from these properties.
+          { # An instance-attached disk resource.
+            "autoDelete": True or False, # Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+            "deviceName": "A String", # Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like disk_name and replica_zones (in case of RePDs)
+            "diskEncryptionKey": { # A customer-supplied encryption key. # Optional. Encrypts or decrypts a disk using a customer-supplied encryption key.
+              "kmsKeyName": "A String", # Optional. The name of the encryption key that is stored in Google Cloud KMS.
+              "kmsKeyServiceAccount": "A String", # Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
+              "rawKey": "A String", # Optional. Specifies a 256-bit customer-supplied encryption key.
+              "rsaEncryptedKey": "A String", # Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+            },
+            "diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk.
+            "diskSizeGb": "A String", # Optional. The size of the disk in GB.
+            "diskType": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd
+            "diskTypeDeprecated": "A String", # Specifies the type of the disk.
+            "guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images.
+              { # Feature type of the Guest OS.
+                "type": "A String", # The ID of a supported feature.
+              },
+            ],
+            "index": "A String", # Optional. A zero-based index to this disk, where 0 is reserved for the boot disk.
+            "initializeParams": { # Specifies the parameters to initialize this disk. # Optional. Specifies the parameters to initialize this disk.
+              "diskName": "A String", # Optional. Specifies the disk name. If not specified, the default is to use the name of the instance.
+              "replicaZones": [ # Optional. URL of the zone where the disk should be created. Required for each regional disk associated with the instance.
+                "A String",
+              ],
+            },
+            "kind": "A String", # Optional. Type of the resource.
+            "license": [ # Optional. Any valid publicly visible licenses.
+              "A String",
+            ],
+            "mode": "A String", # Optional. The mode in which to attach this disk.
+            "savedState": "A String", # Optional. Output only. The state of the disk.
+            "source": "A String", # Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource.
+            "type": "A String", # Optional. Specifies the type of the disk.
+          },
+        ],
+        "guestAccelerator": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.
+          { # A specification of the type and number of accelerator cards attached to the instance.
+            "acceleratorCount": 42, # Optional. The number of the guest accelerator cards exposed to this instance.
+            "acceleratorType": "A String", # Optional. Full or partial URL of the accelerator type resource to attach to this instance.
+          },
+        ],
+        "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false.
+        "keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
+        "labels": { # Labels to apply to instances that are created from these properties.
+          "a_key": "A String",
+        },
+        "machineType": "A String", # The machine type to use for instances that are created from these properties.
+        "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information.
+          "items": [ # Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
+            { # A key/value pair to be used for storing metadata.
+              "key": "A String", # Optional. Key for the metadata entry.
+              "value": "A String", # Optional. Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
+            },
+          ],
+        },
+        "minCpuPlatform": "A String", # Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: Intel Haswell` or `minCpuPlatform: Intel Sandy Bridge`. For more information, read https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
+        "networkInterface": [ # An array of network access configurations for this interface.
+          { # A network interface resource attached to an instance. s
+            "accessConfigs": [ # Optional. An array of configurations for this interface. Currently, only one access config,ONE_TO_ONE_NAT is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+              { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+                "externalIpv6": "A String", # Optional. The external IPv6 address of this access configuration.
+                "externalIpv6PrefixLength": 42, # Optional. The prefix length of the external IPv6 range.
+                "name": "A String", # Optional. The name of this access configuration.
+                "natIP": "A String", # Optional. The external IP address of this access configuration.
+                "networkTier": "A String", # Optional. This signifies the networking tier used for configuring this access
+                "publicPtrDomainName": "A String", # Optional. The DNS domain name for the public PTR record.
+                "setPublicPtr": True or False, # Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
+                "type": "A String", # Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
+              },
+            ],
+            "aliasIpRanges": [ # Optional. An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
+              { # An alias IP range attached to an instance's network interface.
+                "ipCidrRange": "A String", # Optional. The IP alias ranges to allocate for this interface.
+                "subnetworkRangeName": "A String", # Optional. The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.
+              },
+            ],
+            "internalIpv6PrefixLength": 42, # Optional. The prefix length of the primary internal IPv6 range.
+            "ipv6AccessConfigs": [ # Optional. An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.
+              { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+                "externalIpv6": "A String", # Optional. The external IPv6 address of this access configuration.
+                "externalIpv6PrefixLength": 42, # Optional. The prefix length of the external IPv6 range.
+                "name": "A String", # Optional. The name of this access configuration.
+                "natIP": "A String", # Optional. The external IP address of this access configuration.
+                "networkTier": "A String", # Optional. This signifies the networking tier used for configuring this access
+                "publicPtrDomainName": "A String", # Optional. The DNS domain name for the public PTR record.
+                "setPublicPtr": True or False, # Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
+                "type": "A String", # Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
+              },
+            ],
+            "ipv6AccessType": "A String", # Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.
+            "ipv6Address": "A String", # Optional. An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.
+            "name": "A String", # Output only. [Output Only] The name of the network interface, which is generated by the server.
+            "network": "A String", # Optional. URL of the VPC network resource for this instance.
+            "networkAttachment": "A String", # Optional. The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
+            "networkIP": "A String", # Optional. An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+            "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
+            "queueCount": 42, # Optional. The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.
+            "stackType": "A String", # The stack type for this network interface.
+            "subnetwork": "A String", # Optional. The URL of the Subnetwork resource for this instance.
+          },
+        ],
+        "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties.
+          "automaticRestart": True or False, # Optional. Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
+          "instanceTerminationAction": "A String", # Optional. Specifies the termination action for the instance.
+          "localSsdRecoveryTimeout": { # A SchedulingDuration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Optional. Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour.
+            "nanos": 42, # Optional. Span of time that's a fraction of a second at nanosecond resolution.
+            "seconds": "A String", # Optional. Span of time at a resolution of a second.
+          },
+          "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
+          "nodeAffinities": [ # Optional. A set of node affinity and anti-affinity configurations. Overrides reservationAffinity.
+            { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
+              "key": "A String", # Optional. Corresponds to the label key of Node resource.
+              "operator": "A String", # Optional. Defines the operation of node selection.
+              "values": [ # Optional. Corresponds to the label values of Node resource.
+                "A String",
+              ],
+            },
+          ],
+          "onHostMaintenance": "A String", # Optional. Defines the maintenance behavior for this instance.
+          "preemptible": True or False, # Optional. Defines whether the instance is preemptible.
+          "provisioningModel": "A String", # Optional. Specifies the provisioning model of the instance.
+        },
+        "serviceAccount": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.
+          { # A service account.
+            "email": "A String", # Optional. Email address of the service account.
+            "scopes": [ # Optional. The list of scopes to be made available for this service account.
+              "A String",
+            ],
+          },
+        ],
+        "sourceInstance": "A String", # The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance
+        "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt).
+          "items": [ # Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+            "A String",
+          ],
+        },
+      },
+      "consistencyTime": "A String", # Output only. The point in time when this backup was captured from the source.
+      "createTime": "A String", # Output only. The time when the instance was created.
+      "description": "A String", # Output only. The description of the Backup instance (2048 characters or less).
+      "diskBackupProperties": { # DiskBackupProperties represents the properties of a Disk backup. # Output only. Disk specific backup properties.
+        "accessMode": "A String", # The access mode of the source disk.
+        "architecture": "A String", # The architecture of the source disk. Valid values are ARM64 or X86_64.
+        "description": "A String", # A description of the source disk.
+        "enableConfidentialCompute": True or False, # Indicates whether the source disk is using confidential compute mode.
+        "guestFlush": True or False, # Optional. Defines if the guest flush is enabled for the source disk. Default value is false.
+        "guestOsFeature": [ # A list of guest OS features that are applicable to this backup.
+          { # Feature type of the Guest OS.
+            "type": "A String", # The ID of a supported feature.
+          },
+        ],
+        "labels": { # The labels of the source disk.
+          "a_key": "A String",
+        },
+        "licenses": [ # A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image.
+          "A String",
+        ],
+        "physicalBlockSizeBytes": "A String", # The physical block size of the source disk.
+        "provisionedIops": "A String", # The number of IOPS provisioned for the source disk.
+        "provisionedThroughput": "A String", # The number of throughput provisioned for the source disk.
+        "region": "A String", # Region and zone are mutually exclusive fields. The URL of the region of the source disk.
+        "replicaZones": [ # The URL of the Zones where the source disk should be replicated.
+          "A String",
+        ],
+        "sizeGb": "A String", # Size(in GB) of the source disk.
+        "sourceDisk": "A String", # The source disk used to create this backup.
+        "storagePool": "A String", # The storage pool of the source disk.
+        "type": "A String", # The URL of the type of the disk.
+        "zone": "A String", # The URL of the Zone where the source disk.
+      },
+      "enforcedRetentionEndTime": "A String", # Optional. The backup can not be deleted before this time.
+      "etag": "A String", # Optional. Server specified ETag to prevent updates from overwriting each other.
+      "expireTime": "A String", # Optional. When this backup is automatically expired.
+      "filestoreInstanceBackupProperties": { # FilestoreInstanceBackupProperties represents the properties of a Filestore instance that are backed up by the datasource. . # Output only. Filestore specific backup properties.
+        "sourceInstance": "A String", # Output only. The source instance of the backup.
+      },
+      "gcpBackupPlanInfo": { # GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup. # Output only. Configuration for a Google Cloud resource.
+        "backupPlan": "A String", # Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
+        "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup.
+        "backupPlanRevisionName": "A String", # Resource name of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}/revisions/{revisionId}
+        "backupPlanRuleId": "A String", # The rule id of the backup plan which triggered this backup in case of scheduled backup or used for
+      },
+      "gcpResource": { # Minimum details to identify a Google Cloud resource for a backup. # Output only. Unique identifier of the GCP resource that is being backed up.
+        "gcpResourcename": "A String", # Name of the Google Cloud resource.
+        "location": "A String", # Location of the resource: //"global"/"unspecified".
+        "type": "A String", # Type of the resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.
+      },
+      "kmsKeyVersions": [ # Optional. Output only. The list of KMS key versions used to encrypt the backup.
+        "A String",
+      ],
+      "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. Name of the backup to create. It must have the format`"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}"`. `{backup}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.
+      "resourceSizeBytes": "A String", # Output only. source resource size in bytes at the time of the backup.
+      "satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
+      "satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
+      "serviceLocks": [ # Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.
+        { # BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.
+          "backupApplianceLockInfo": { # BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. # If the client is a backup and recovery appliance, this contains metadata about why the lock exists.
+            "backupApplianceId": "A String", # Required. The ID of the backup/recovery appliance that created this lock.
+            "backupApplianceName": "A String", # Required. The name of the backup/recovery appliance that created this lock.
+            "backupImage": "A String", # The image name that depends on this Backup.
+            "jobName": "A String", # The job name on the backup/recovery appliance that created this lock.
+            "lockReason": "A String", # Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service.
+            "slaId": "A String", # The SLA on the backup/recovery appliance that owns the lock.
+          },
+          "lockUntilTime": "A String", # Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion.
+          "serviceLockInfo": { # ServiceLockInfo represents the details of a lock taken by the service on a Backup resource. # Output only. Contains metadata about the lock exist for Google Cloud native backups.
+            "operation": "A String", # Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes.
+          },
+        },
+      ],
+      "state": "A String", # Output only. The Backup resource instance state.
+      "updateTime": "A String", # Output only. The time when the instance was updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Updates the settings of a Backup.
+
+Args:
+  name: string, Output only. Identifier. Name of the backup to create. It must have the format`"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}"`. `{backup}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing a Backup object.
+  "alloyDbBackupProperties": { # AlloyDbClusterBackupProperties represents AlloyDB cluster backup properties. . # Output only. AlloyDB specific backup properties.
+    "chainId": "A String", # Output only. The chain id of this backup. Backups belonging to the same chain are sharing the same chain id. This property is calculated and maintained by BackupDR.
+    "databaseVersion": "A String", # Output only. The PostgreSQL major version of the AlloyDB cluster when the backup was taken.
+    "description": "A String", # An optional text description for the backup.
+    "storedBytes": "A String", # Output only. Storage usage of this particular backup
+  },
+  "backupApplianceBackupProperties": { # BackupApplianceBackupProperties represents BackupDR backup appliance's properties. # Output only. Backup Appliance specific backup properties.
+    "finalizeTime": "A String", # Output only. The time when this backup object was finalized (if none, backup is not finalized).
+    "generationId": 42, # Output only. The numeric generation ID of the backup (monotonically increasing).
+    "recoveryRangeEndTime": "A String", # Optional. The latest timestamp of data available in this Backup.
+    "recoveryRangeStartTime": "A String", # Optional. The earliest timestamp of data available in this Backup.
+  },
+  "backupApplianceLocks": [ # Optional. The list of BackupLocks taken by the accessor Backup Appliance.
+    { # BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.
+      "backupApplianceLockInfo": { # BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. # If the client is a backup and recovery appliance, this contains metadata about why the lock exists.
+        "backupApplianceId": "A String", # Required. The ID of the backup/recovery appliance that created this lock.
+        "backupApplianceName": "A String", # Required. The name of the backup/recovery appliance that created this lock.
+        "backupImage": "A String", # The image name that depends on this Backup.
+        "jobName": "A String", # The job name on the backup/recovery appliance that created this lock.
+        "lockReason": "A String", # Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service.
+        "slaId": "A String", # The SLA on the backup/recovery appliance that owns the lock.
+      },
+      "lockUntilTime": "A String", # Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion.
+      "serviceLockInfo": { # ServiceLockInfo represents the details of a lock taken by the service on a Backup resource. # Output only. Contains metadata about the lock exist for Google Cloud native backups.
+        "operation": "A String", # Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes.
+      },
+    },
+  ],
+  "backupRetentionInheritance": "A String", # Output only. Setting for how the enforced retention end time is inherited. This value is copied from this backup's BackupVault.
+  "backupType": "A String", # Output only. Type of the backup, unspecified, scheduled or ondemand.
+  "cloudSqlInstanceBackupProperties": { # CloudSqlInstanceBackupProperties represents Cloud SQL Instance Backup properties. # Output only. Cloud SQL specific backup properties.
+    "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance when the backup was taken.
+    "finalBackup": True or False, # Output only. Whether the backup is a final backup.
+    "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+    "instanceDeleteTime": "A String", # Output only. The instance delete timestamp.
+    "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`
+    "sourceInstance": "A String", # Output only. The source instance of the backup. Format: projects/{project}/instances/{instance}
+  },
+  "computeInstanceBackupProperties": { # ComputeInstanceBackupProperties represents Compute Engine instance backup properties. # Output only. Compute Engine specific backup properties.
+    "canIpForward": True or False, # Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify `true`. If unsure, leave this set to `false`. See the https://cloud.google.com/vpc/docs/using-routes#canipforward documentation for more information.
+    "description": "A String", # An optional text description for the instances that are created from these properties.
+    "disk": [ # An array of disks that are associated with the instances that are created from these properties.
+      { # An instance-attached disk resource.
+        "autoDelete": True or False, # Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+        "boot": True or False, # Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+        "deviceName": "A String", # Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like disk_name and replica_zones (in case of RePDs)
+        "diskEncryptionKey": { # A customer-supplied encryption key. # Optional. Encrypts or decrypts a disk using a customer-supplied encryption key.
+          "kmsKeyName": "A String", # Optional. The name of the encryption key that is stored in Google Cloud KMS.
+          "kmsKeyServiceAccount": "A String", # Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
+          "rawKey": "A String", # Optional. Specifies a 256-bit customer-supplied encryption key.
+          "rsaEncryptedKey": "A String", # Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+        },
+        "diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk.
+        "diskSizeGb": "A String", # Optional. The size of the disk in GB.
+        "diskType": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd
+        "diskTypeDeprecated": "A String", # Specifies the type of the disk.
+        "guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images.
+          { # Feature type of the Guest OS.
+            "type": "A String", # The ID of a supported feature.
+          },
+        ],
+        "index": "A String", # Optional. A zero-based index to this disk, where 0 is reserved for the boot disk.
+        "initializeParams": { # Specifies the parameters to initialize this disk. # Optional. Specifies the parameters to initialize this disk.
+          "diskName": "A String", # Optional. Specifies the disk name. If not specified, the default is to use the name of the instance.
+          "replicaZones": [ # Optional. URL of the zone where the disk should be created. Required for each regional disk associated with the instance.
+            "A String",
+          ],
+        },
+        "kind": "A String", # Optional. Type of the resource.
+        "license": [ # Optional. Any valid publicly visible licenses.
+          "A String",
+        ],
+        "mode": "A String", # Optional. The mode in which to attach this disk.
+        "savedState": "A String", # Optional. Output only. The state of the disk.
+        "source": "A String", # Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource.
+        "type": "A String", # Optional. Specifies the type of the disk.
+      },
+    ],
+    "guestAccelerator": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.
+      { # A specification of the type and number of accelerator cards attached to the instance.
+        "acceleratorCount": 42, # Optional. The number of the guest accelerator cards exposed to this instance.
+        "acceleratorType": "A String", # Optional. Full or partial URL of the accelerator type resource to attach to this instance.
+      },
+    ],
+    "guestFlush": True or False, # Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false.
+    "keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
+    "labels": { # Labels to apply to instances that are created from these properties.
+      "a_key": "A String",
+    },
+    "machineType": "A String", # The machine type to use for instances that are created from these properties.
+    "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information.
+      "items": [ # Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
+        { # A key/value pair to be used for storing metadata.
+          "key": "A String", # Optional. Key for the metadata entry.
+          "value": "A String", # Optional. Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
+        },
+      ],
+    },
+    "minCpuPlatform": "A String", # Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: Intel Haswell` or `minCpuPlatform: Intel Sandy Bridge`. For more information, read https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
+    "networkInterface": [ # An array of network access configurations for this interface.
+      { # A network interface resource attached to an instance. s
+        "accessConfigs": [ # Optional. An array of configurations for this interface. Currently, only one access config,ONE_TO_ONE_NAT is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+          { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+            "externalIpv6": "A String", # Optional. The external IPv6 address of this access configuration.
+            "externalIpv6PrefixLength": 42, # Optional. The prefix length of the external IPv6 range.
+            "name": "A String", # Optional. The name of this access configuration.
+            "natIP": "A String", # Optional. The external IP address of this access configuration.
+            "networkTier": "A String", # Optional. This signifies the networking tier used for configuring this access
+            "publicPtrDomainName": "A String", # Optional. The DNS domain name for the public PTR record.
+            "setPublicPtr": True or False, # Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
+            "type": "A String", # Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
+          },
+        ],
+        "aliasIpRanges": [ # Optional. An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
+          { # An alias IP range attached to an instance's network interface.
+            "ipCidrRange": "A String", # Optional. The IP alias ranges to allocate for this interface.
+            "subnetworkRangeName": "A String", # Optional. The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.
+          },
+        ],
+        "internalIpv6PrefixLength": 42, # Optional. The prefix length of the primary internal IPv6 range.
+        "ipv6AccessConfigs": [ # Optional. An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.
+          { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+            "externalIpv6": "A String", # Optional. The external IPv6 address of this access configuration.
+            "externalIpv6PrefixLength": 42, # Optional. The prefix length of the external IPv6 range.
+            "name": "A String", # Optional. The name of this access configuration.
+            "natIP": "A String", # Optional. The external IP address of this access configuration.
+            "networkTier": "A String", # Optional. This signifies the networking tier used for configuring this access
+            "publicPtrDomainName": "A String", # Optional. The DNS domain name for the public PTR record.
+            "setPublicPtr": True or False, # Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
+            "type": "A String", # Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
+          },
+        ],
+        "ipv6AccessType": "A String", # Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.
+        "ipv6Address": "A String", # Optional. An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.
+        "name": "A String", # Output only. [Output Only] The name of the network interface, which is generated by the server.
+        "network": "A String", # Optional. URL of the VPC network resource for this instance.
+        "networkAttachment": "A String", # Optional. The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
+        "networkIP": "A String", # Optional. An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+        "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
+        "queueCount": 42, # Optional. The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.
+        "stackType": "A String", # The stack type for this network interface.
+        "subnetwork": "A String", # Optional. The URL of the Subnetwork resource for this instance.
+      },
+    ],
+    "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties.
+      "automaticRestart": True or False, # Optional. Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
+      "instanceTerminationAction": "A String", # Optional. Specifies the termination action for the instance.
+      "localSsdRecoveryTimeout": { # A SchedulingDuration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Optional. Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour.
+        "nanos": 42, # Optional. Span of time that's a fraction of a second at nanosecond resolution.
+        "seconds": "A String", # Optional. Span of time at a resolution of a second.
+      },
+      "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
+      "nodeAffinities": [ # Optional. A set of node affinity and anti-affinity configurations. Overrides reservationAffinity.
+        { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
+          "key": "A String", # Optional. Corresponds to the label key of Node resource.
+          "operator": "A String", # Optional. Defines the operation of node selection.
+          "values": [ # Optional. Corresponds to the label values of Node resource.
+            "A String",
+          ],
+        },
+      ],
+      "onHostMaintenance": "A String", # Optional. Defines the maintenance behavior for this instance.
+      "preemptible": True or False, # Optional. Defines whether the instance is preemptible.
+      "provisioningModel": "A String", # Optional. Specifies the provisioning model of the instance.
+    },
+    "serviceAccount": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.
+      { # A service account.
+        "email": "A String", # Optional. Email address of the service account.
+        "scopes": [ # Optional. The list of scopes to be made available for this service account.
+          "A String",
+        ],
+      },
+    ],
+    "sourceInstance": "A String", # The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance
+    "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt).
+      "items": [ # Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+        "A String",
+      ],
+    },
+  },
+  "consistencyTime": "A String", # Output only. The point in time when this backup was captured from the source.
+  "createTime": "A String", # Output only. The time when the instance was created.
+  "description": "A String", # Output only. The description of the Backup instance (2048 characters or less).
+  "diskBackupProperties": { # DiskBackupProperties represents the properties of a Disk backup. # Output only. Disk specific backup properties.
+    "accessMode": "A String", # The access mode of the source disk.
+    "architecture": "A String", # The architecture of the source disk. Valid values are ARM64 or X86_64.
+    "description": "A String", # A description of the source disk.
+    "enableConfidentialCompute": True or False, # Indicates whether the source disk is using confidential compute mode.
+    "guestFlush": True or False, # Optional. Defines if the guest flush is enabled for the source disk. Default value is false.
+    "guestOsFeature": [ # A list of guest OS features that are applicable to this backup.
+      { # Feature type of the Guest OS.
+        "type": "A String", # The ID of a supported feature.
+      },
+    ],
+    "labels": { # The labels of the source disk.
+      "a_key": "A String",
+    },
+    "licenses": [ # A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image.
+      "A String",
+    ],
+    "physicalBlockSizeBytes": "A String", # The physical block size of the source disk.
+    "provisionedIops": "A String", # The number of IOPS provisioned for the source disk.
+    "provisionedThroughput": "A String", # The number of throughput provisioned for the source disk.
+    "region": "A String", # Region and zone are mutually exclusive fields. The URL of the region of the source disk.
+    "replicaZones": [ # The URL of the Zones where the source disk should be replicated.
+      "A String",
+    ],
+    "sizeGb": "A String", # Size(in GB) of the source disk.
+    "sourceDisk": "A String", # The source disk used to create this backup.
+    "storagePool": "A String", # The storage pool of the source disk.
+    "type": "A String", # The URL of the type of the disk.
+    "zone": "A String", # The URL of the Zone where the source disk.
+  },
+  "enforcedRetentionEndTime": "A String", # Optional. The backup can not be deleted before this time.
+  "etag": "A String", # Optional. Server specified ETag to prevent updates from overwriting each other.
+  "expireTime": "A String", # Optional. When this backup is automatically expired.
+  "filestoreInstanceBackupProperties": { # FilestoreInstanceBackupProperties represents the properties of a Filestore instance that are backed up by the datasource. . # Output only. Filestore specific backup properties.
+    "sourceInstance": "A String", # Output only. The source instance of the backup.
+  },
+  "gcpBackupPlanInfo": { # GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup. # Output only. Configuration for a Google Cloud resource.
+    "backupPlan": "A String", # Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
+    "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup.
+    "backupPlanRevisionName": "A String", # Resource name of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}/revisions/{revisionId}
+    "backupPlanRuleId": "A String", # The rule id of the backup plan which triggered this backup in case of scheduled backup or used for
+  },
+  "gcpResource": { # Minimum details to identify a Google Cloud resource for a backup. # Output only. Unique identifier of the GCP resource that is being backed up.
+    "gcpResourcename": "A String", # Name of the Google Cloud resource.
+    "location": "A String", # Location of the resource: //"global"/"unspecified".
+    "type": "A String", # Type of the resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.
+  },
+  "kmsKeyVersions": [ # Optional. Output only. The list of KMS key versions used to encrypt the backup.
+    "A String",
+  ],
+  "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined.
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. Identifier. Name of the backup to create. It must have the format`"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}"`. `{backup}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.
+  "resourceSizeBytes": "A String", # Output only. source resource size in bytes at the time of the backup.
+  "satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
+  "satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
+  "serviceLocks": [ # Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.
+    { # BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.
+      "backupApplianceLockInfo": { # BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. # If the client is a backup and recovery appliance, this contains metadata about why the lock exists.
+        "backupApplianceId": "A String", # Required. The ID of the backup/recovery appliance that created this lock.
+        "backupApplianceName": "A String", # Required. The name of the backup/recovery appliance that created this lock.
+        "backupImage": "A String", # The image name that depends on this Backup.
+        "jobName": "A String", # The job name on the backup/recovery appliance that created this lock.
+        "lockReason": "A String", # Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service.
+        "slaId": "A String", # The SLA on the backup/recovery appliance that owns the lock.
+      },
+      "lockUntilTime": "A String", # Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion.
+      "serviceLockInfo": { # ServiceLockInfo represents the details of a lock taken by the service on a Backup resource. # Output only. Contains metadata about the lock exist for Google Cloud native backups.
+        "operation": "A String", # Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes.
+      },
+    },
+  ],
+  "state": "A String", # Output only. The Backup resource instance state.
+  "updateTime": "A String", # Output only. The time when the instance was updated.
+}
+
+  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, Required. Field mask is used to specify the fields to be overwritten in the Backup 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 the 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:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ restore(name, body=None, x__xgafv=None) +
Restore from a Backup
+
+Args:
+  name: string, Required. The resource name of the Backup instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/*/backups/'. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for restoring from a Backup.
+  "clearOverridesFieldMask": "A String", # Optional. A field mask used to clear server-side default values for fields within the `instance_properties` oneof. When a field in this mask is cleared, the server will not apply its default logic (like inheriting a value from the source) for that field. The most common current use case is clearing default encryption keys. Examples of field mask paths: - Compute Instance Disks: `compute_instance_restore_properties.disks.*.disk_encryption_key` - Single Disk: `disk_restore_properties.disk_encryption_key`
+  "computeInstanceRestoreProperties": { # ComputeInstanceRestoreProperties represents Compute Engine instance properties to be overridden during restore. # Compute Engine instance properties to be overridden during restore.
+    "advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Optional. Controls for advanced machine-related behavior features.
+      "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization or not (default is false).
+      "enableUefiNetworking": True or False, # Optional. Whether to enable UEFI networking for instance creation.
+      "threadsPerCore": 42, # Optional. The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
+      "visibleCoreCount": 42, # Optional. The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.
+    },
+    "canIpForward": True or False, # Optional. Allows this instance to send and receive packets with non-matching destination or source IPs.
+    "confidentialInstanceConfig": { # A set of Confidential Instance options. # Optional. Controls Confidential compute options on the instance
+      "enableConfidentialCompute": True or False, # Optional. Defines whether the instance should have confidential compute enabled.
+    },
+    "deletionProtection": True or False, # Optional. Whether the resource should be protected against deletion.
+    "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
+    "disks": [ # Optional. Array of disks associated with this instance. Persistent disks must be created before you can assign them. Source regional persistent disks will be restored with default replica zones if not specified.
+      { # An instance-attached disk resource.
+        "autoDelete": True or False, # Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+        "boot": True or False, # Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+        "deviceName": "A String", # Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like disk_name and replica_zones (in case of RePDs)
+        "diskEncryptionKey": { # A customer-supplied encryption key. # Optional. Encrypts or decrypts a disk using a customer-supplied encryption key.
+          "kmsKeyName": "A String", # Optional. The name of the encryption key that is stored in Google Cloud KMS.
+          "kmsKeyServiceAccount": "A String", # Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
+          "rawKey": "A String", # Optional. Specifies a 256-bit customer-supplied encryption key.
+          "rsaEncryptedKey": "A String", # Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+        },
+        "diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk.
+        "diskSizeGb": "A String", # Optional. The size of the disk in GB.
+        "diskType": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd
+        "diskTypeDeprecated": "A String", # Specifies the type of the disk.
+        "guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images.
+          { # Feature type of the Guest OS.
+            "type": "A String", # The ID of a supported feature.
+          },
+        ],
+        "index": "A String", # Optional. A zero-based index to this disk, where 0 is reserved for the boot disk.
+        "initializeParams": { # Specifies the parameters to initialize this disk. # Optional. Specifies the parameters to initialize this disk.
+          "diskName": "A String", # Optional. Specifies the disk name. If not specified, the default is to use the name of the instance.
+          "replicaZones": [ # Optional. URL of the zone where the disk should be created. Required for each regional disk associated with the instance.
+            "A String",
+          ],
+        },
+        "kind": "A String", # Optional. Type of the resource.
+        "license": [ # Optional. Any valid publicly visible licenses.
+          "A String",
+        ],
+        "mode": "A String", # Optional. The mode in which to attach this disk.
+        "savedState": "A String", # Optional. Output only. The state of the disk.
+        "source": "A String", # Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource.
+        "type": "A String", # Optional. Specifies the type of the disk.
+      },
+    ],
+    "displayDevice": { # A set of Display Device options # Optional. Enables display device for the instance.
+      "enableDisplay": True or False, # Optional. Enables display for the Compute Engine VM
+    },
+    "guestAccelerators": [ # Optional. A list of the type and count of accelerator cards attached to the instance.
+      { # A specification of the type and number of accelerator cards attached to the instance.
+        "acceleratorCount": 42, # Optional. The number of the guest accelerator cards exposed to this instance.
+        "acceleratorType": "A String", # Optional. Full or partial URL of the accelerator type resource to attach to this instance.
+      },
+    ],
+    "hostname": "A String", # Optional. Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
+    "instanceEncryptionKey": { # A customer-supplied encryption key. # Optional. Encrypts suspended data for an instance with a customer-managed encryption key.
+      "kmsKeyName": "A String", # Optional. The name of the encryption key that is stored in Google Cloud KMS.
+      "kmsKeyServiceAccount": "A String", # Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
+      "rawKey": "A String", # Optional. Specifies a 256-bit customer-supplied encryption key.
+      "rsaEncryptedKey": "A String", # Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+    },
+    "keyRevocationActionType": "A String", # Optional. KeyRevocationActionType of the instance.
+    "labels": { # Optional. Labels to apply to this instance.
+      "a_key": "A String",
+    },
+    "machineType": "A String", # Optional. Full or partial URL of the machine type resource to use for this instance.
+    "metadata": { # A metadata key/value entry. # Optional. This includes custom metadata and predefined keys.
+      "items": [ # Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
+        { # A key/value pair to be used for storing metadata.
+          "key": "A String", # Optional. Key for the metadata entry.
+          "value": "A String", # Optional. Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
+        },
+      ],
+    },
+    "minCpuPlatform": "A String", # Optional. Minimum CPU platform to use for this instance.
+    "name": "A String", # Required. Name of the compute instance.
+    "networkInterfaces": [ # Optional. An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. Required to restore in different project or region.
+      { # A network interface resource attached to an instance. s
+        "accessConfigs": [ # Optional. An array of configurations for this interface. Currently, only one access config,ONE_TO_ONE_NAT is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+          { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+            "externalIpv6": "A String", # Optional. The external IPv6 address of this access configuration.
+            "externalIpv6PrefixLength": 42, # Optional. The prefix length of the external IPv6 range.
+            "name": "A String", # Optional. The name of this access configuration.
+            "natIP": "A String", # Optional. The external IP address of this access configuration.
+            "networkTier": "A String", # Optional. This signifies the networking tier used for configuring this access
+            "publicPtrDomainName": "A String", # Optional. The DNS domain name for the public PTR record.
+            "setPublicPtr": True or False, # Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
+            "type": "A String", # Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
+          },
+        ],
+        "aliasIpRanges": [ # Optional. An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
+          { # An alias IP range attached to an instance's network interface.
+            "ipCidrRange": "A String", # Optional. The IP alias ranges to allocate for this interface.
+            "subnetworkRangeName": "A String", # Optional. The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.
+          },
+        ],
+        "internalIpv6PrefixLength": 42, # Optional. The prefix length of the primary internal IPv6 range.
+        "ipv6AccessConfigs": [ # Optional. An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.
+          { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+            "externalIpv6": "A String", # Optional. The external IPv6 address of this access configuration.
+            "externalIpv6PrefixLength": 42, # Optional. The prefix length of the external IPv6 range.
+            "name": "A String", # Optional. The name of this access configuration.
+            "natIP": "A String", # Optional. The external IP address of this access configuration.
+            "networkTier": "A String", # Optional. This signifies the networking tier used for configuring this access
+            "publicPtrDomainName": "A String", # Optional. The DNS domain name for the public PTR record.
+            "setPublicPtr": True or False, # Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
+            "type": "A String", # Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
+          },
+        ],
+        "ipv6AccessType": "A String", # Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.
+        "ipv6Address": "A String", # Optional. An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.
+        "name": "A String", # Output only. [Output Only] The name of the network interface, which is generated by the server.
+        "network": "A String", # Optional. URL of the VPC network resource for this instance.
+        "networkAttachment": "A String", # Optional. The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
+        "networkIP": "A String", # Optional. An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+        "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
+        "queueCount": 42, # Optional. The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.
+        "stackType": "A String", # The stack type for this network interface.
+        "subnetwork": "A String", # Optional. The URL of the Subnetwork resource for this instance.
+      },
+    ],
+    "networkPerformanceConfig": { # Network performance configuration. # Optional. Configure network performance such as egress bandwidth tier.
+      "totalEgressBandwidthTier": "A String", # Optional. The tier of the total egress bandwidth.
+    },
+    "params": { # Additional instance params. # Input only. Additional params passed with the request, but not persisted as part of resource payload.
+      "resourceManagerTags": { # Optional. Resource manager tags to be bound to the instance.
+        "a_key": "A String",
+      },
+    },
+    "privateIpv6GoogleAccess": "A String", # Optional. The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
+    "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Optional. Specifies the reservations that this instance can consume from.
+      "consumeReservationType": "A String", # Optional. Specifies the type of reservation from which this instance can consume
+      "key": "A String", # Optional. Corresponds to the label key of a reservation resource.
+      "values": [ # Optional. Corresponds to the label values of a reservation resource.
+        "A String",
+      ],
+    },
+    "resourcePolicies": [ # Optional. Resource policies applied to this instance. By default, no resource policies will be applied.
+      "A String",
+    ],
+    "scheduling": { # Sets the scheduling options for an Instance. # Optional. Sets the scheduling options for this instance.
+      "automaticRestart": True or False, # Optional. Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
+      "instanceTerminationAction": "A String", # Optional. Specifies the termination action for the instance.
+      "localSsdRecoveryTimeout": { # A SchedulingDuration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Optional. Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour.
+        "nanos": 42, # Optional. Span of time that's a fraction of a second at nanosecond resolution.
+        "seconds": "A String", # Optional. Span of time at a resolution of a second.
+      },
+      "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
+      "nodeAffinities": [ # Optional. A set of node affinity and anti-affinity configurations. Overrides reservationAffinity.
+        { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
+          "key": "A String", # Optional. Corresponds to the label key of Node resource.
+          "operator": "A String", # Optional. Defines the operation of node selection.
+          "values": [ # Optional. Corresponds to the label values of Node resource.
+            "A String",
+          ],
+        },
+      ],
+      "onHostMaintenance": "A String", # Optional. Defines the maintenance behavior for this instance.
+      "preemptible": True or False, # Optional. Defines whether the instance is preemptible.
+      "provisioningModel": "A String", # Optional. Specifies the provisioning model of the instance.
+    },
+    "serviceAccounts": [ # Optional. A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.
+      { # A service account.
+        "email": "A String", # Optional. Email address of the service account.
+        "scopes": [ # Optional. The list of scopes to be made available for this service account.
+          "A String",
+        ],
+      },
+    ],
+    "tags": { # A set of instance tags. # Optional. Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation.
+      "items": [ # Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+        "A String",
+      ],
+    },
+  },
+  "computeInstanceTargetEnvironment": { # ComputeInstanceTargetEnvironment represents Compute Engine target environment to be used during restore. # Compute Engine target environment to be used during restore.
+    "project": "A String", # Required. Target project for the Compute Engine instance.
+    "useProjectServiceAccount": True or False, # Optional. Whether to use the project service account for the Compute Engine instance restore.
+    "zone": "A String", # Required. The zone of the Compute Engine instance.
+  },
+  "diskRestoreProperties": { # DiskRestoreProperties represents the properties of a Disk restore. # Disk properties to be overridden during restore.
+    "accessMode": "A String", # Optional. The access mode of the disk.
+    "architecture": "A String", # Optional. The architecture of the source disk. Valid values are ARM64 or X86_64.
+    "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
+    "diskEncryptionKey": { # A customer-supplied encryption key. # Optional. Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key.
+      "kmsKeyName": "A String", # Optional. The name of the encryption key that is stored in Google Cloud KMS.
+      "kmsKeyServiceAccount": "A String", # Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
+      "rawKey": "A String", # Optional. Specifies a 256-bit customer-supplied encryption key.
+      "rsaEncryptedKey": "A String", # Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+    },
+    "enableConfidentialCompute": True or False, # Optional. Indicates whether this disk is using confidential compute mode. Encryption with a Cloud KMS key is required to enable this option.
+    "guestOsFeature": [ # Optional. A list of features to enable in the guest operating system. This is applicable only for bootable images.
+      { # Feature type of the Guest OS.
+        "type": "A String", # The ID of a supported feature.
+      },
+    ],
+    "instanceBackupSource": { # Options for creating a disk from a source Compute Instance backup. # Options for creating a disk from a source Compute Instance backup.
+      "bootDisk": True or False, # Set to true to restore the boot disk from the instance backup. This field should only be set to true if selected.
+      "sourceDeviceName": "A String", # The device name of the disk to restore from the VM backup.
+    },
+    "labels": { # Optional. Labels to apply to this disk. These can be modified later using setLabels method. Label values can be empty.
+      "a_key": "A String",
+    },
+    "licenses": [ # Optional. A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image
+      "A String",
+    ],
+    "name": "A String", # Required. Name of the disk.
+    "physicalBlockSizeBytes": "A String", # Optional. Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently, the supported size is 4096.
+    "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle.
+    "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle.
+    "resourceManagerTags": { # Optional. Resource manager tags to be bound to the disk.
+      "a_key": "A String",
+    },
+    "resourcePolicy": [ # Optional. Resource policies applied to this disk.
+      "A String",
+    ],
+    "sizeGb": "A String", # Required. The size of the disk in GB.
+    "storagePool": "A String", # Optional. The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource.
+    "type": "A String", # Required. URL of the disk type resource describing which disk type to use to create the disk.
+  },
+  "diskTargetEnvironment": { # DiskTargetEnvironment represents the target environment for the disk. # Disk target environment to be used during restore.
+    "project": "A String", # Required. Target project for the disk.
+    "useProjectServiceAccount": True or False, # Optional. Whether to use the project service account for the disk restore.
+    "zone": "A String", # Required. Target zone for the disk.
+  },
+  "regionDiskTargetEnvironment": { # RegionDiskTargetEnvironment represents the target environment for the disk. # Region disk target environment to be used during restore.
+    "project": "A String", # Required. Target project for the disk.
+    "region": "A String", # Required. Target region for the disk.
+    "replicaZones": [ # Required. Target URLs of the replica zones for the disk.
+      "A String",
+    ],
+    "useProjectServiceAccount": True or False, # Optional. Whether to use the project service account for the disk restore.
+  },
+  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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/backupdr_v1beta.projects.locations.backupVaults.dataSources.html b/docs/dyn/backupdr_v1beta.projects.locations.backupVaults.dataSources.html new file mode 100644 index 0000000000..94bbf4ed53 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.locations.backupVaults.dataSources.html @@ -0,0 +1,740 @@ + + + +

Backup and DR Service API . projects . locations . backupVaults . dataSources

+

Instance Methods

+

+ backups() +

+

Returns the backups Resource.

+ +

+ abandonBackup(dataSource, body=None, x__xgafv=None)

+

Internal only. Abandons a backup.

+

+ close()

+

Close httplib2 connections.

+

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

+

Internal only. Fetch access token for a given data source.

+

+ finalizeBackup(dataSource, body=None, x__xgafv=None)

+

Internal only. Finalize a backup that was started by a call to InitiateBackup.

+

+ get(name, x__xgafv=None)

+

Gets details of a DataSource.

+

+ initiateBackup(dataSource, body=None, x__xgafv=None)

+

Internal only. Initiates a backup.

+

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

+

Lists DataSources in a given project and location.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates the settings of a DataSource.

+

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

+

Deletes a DataSource. This is a custom method instead of a standard delete method because external clients will not delete DataSources except for BackupDR backup appliances.

+

+ setInternalStatus(dataSource, body=None, x__xgafv=None)

+

Sets the internal status of a DataSource.

+

Method Details

+
+ abandonBackup(dataSource, body=None, x__xgafv=None) +
Internal only. Abandons a backup.
+
+Args:
+  dataSource: string, Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # request message for AbandonBackup.
+  "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 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:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ fetchAccessToken(name, body=None, x__xgafv=None) +
Internal only. Fetch access token for a given data source.
+
+Args:
+  name: string, Required. The resource name for the location for which static IPs should be returned. Must be in the format 'projects/*/locations/*/backupVaults/*/dataSources'. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for FetchAccessToken.
+  "generationId": 42, # Required. The generation of the backup to update.
+}
+
+  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 FetchAccessToken.
+  "expireTime": "A String", # The token is valid until this time.
+  "readLocation": "A String", # The location in bucket that can be used for reading.
+  "token": "A String", # Input only. The downscoped token that was created.
+  "writeLocation": "A String", # The location in bucket that can be used for writing.
+}
+
+ +
+ finalizeBackup(dataSource, body=None, x__xgafv=None) +
Internal only. Finalize a backup that was started by a call to InitiateBackup.
+
+Args:
+  dataSource: string, Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for finalizing a Backup.
+  "backupId": "A String", # Required. Resource ID of the Backup resource to be finalized. This must be the same backup_id that was used in the InitiateBackupRequest.
+  "consistencyTime": "A String", # The point in time when this backup was captured from the source. This will be assigned to the consistency_time field of the newly created Backup.
+  "description": "A String", # This will be assigned to the description field of the newly created Backup.
+  "recoveryRangeEndTime": "A String", # The latest timestamp of data available in this Backup. This will be set on the newly created Backup.
+  "recoveryRangeStartTime": "A String", # The earliest timestamp of data available in this Backup. This will set on the newly created Backup.
+  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  "retentionDuration": "A String", # The ExpireTime on the backup will be set to FinalizeTime plus this duration. If the resulting ExpireTime is less than EnforcedRetentionEndTime, then ExpireTime is set to EnforcedRetentionEndTime.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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 DataSource.
+
+Args:
+  name: string, Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}/dataSource/{resource_name}' (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 a DataSource object. Datasource object used to represent Datasource details for both admin and basic view.
+  "backupBlockedByVaultAccessRestriction": True or False, # Output only. This field is set to true if the backup is blocked by vault access restriction.
+  "backupConfigInfo": { # BackupConfigInfo has information about how the resource is configured for Backup and about the most recent backup to this vault. # Output only. Details of how the resource is configured for backup.
+    "backupApplianceBackupConfig": { # BackupApplianceBackupConfig captures the backup configuration for applications that are protected by Backup Appliances. # Configuration for an application backed up by a Backup Appliance.
+      "applicationName": "A String", # The name of the application.
+      "backupApplianceId": "A String", # The ID of the backup appliance.
+      "backupApplianceName": "A String", # The name of the backup appliance.
+      "hostName": "A String", # The name of the host where the application is running.
+      "slaId": "A String", # The ID of the SLA of this application.
+      "slpName": "A String", # The name of the SLP associated with the application.
+      "sltName": "A String", # The name of the SLT associated with the application.
+    },
+    "gcpBackupConfig": { # GcpBackupConfig captures the Backup configuration details for Google Cloud resources. All Google Cloud resources regardless of type are protected with backup plan associations. # Configuration for a Google Cloud resource.
+      "autoProtectionPolicyBinding": "A String", # Output only. The resource name of the `AutoProtectionPolicyBinding` that manages this datasource, if any. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}`.
+      "backupPlan": "A String", # The name of the backup plan.
+      "backupPlanAssociation": "A String", # The name of the backup plan association.
+      "backupPlanDescription": "A String", # The description of the backup plan.
+      "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision. E.g. v0, v1 etc.
+      "backupPlanRevisionName": "A String", # The name of the backup plan revision.
+      "backupPlanRules": [ # The names of the backup plan rules which point to this backupvault
+        "A String",
+      ],
+    },
+    "lastBackupError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. If the last backup failed, this field has the error message.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+      ],
+      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+    },
+    "lastBackupState": "A String", # Output only. The status of the last backup to this BackupVault
+    "lastSuccessfulBackupConsistencyTime": "A String", # Output only. If the last backup were successful, this field has the consistency date.
+  },
+  "backupCount": "A String", # Number of backups in the data source.
+  "configState": "A String", # Output only. The backup configuration state.
+  "createTime": "A String", # Output only. The time when the instance was created.
+  "dataSourceBackupApplianceApplication": { # BackupApplianceApplication describes a Source Resource when it is an application backed up by a BackupAppliance. # The backed up resource is a backup appliance application.
+    "applianceId": "A String", # Appliance Id of the Backup Appliance.
+    "applicationId": "A String", # The appid field of the application within the Backup Appliance.
+    "applicationName": "A String", # The name of the Application as known to the Backup Appliance.
+    "backupAppliance": "A String", # Appliance name.
+    "hostId": "A String", # Hostid of the application host.
+    "hostname": "A String", # Hostname of the host where the application is running.
+    "type": "A String", # The type of the application. e.g. VMBackup
+  },
+  "dataSourceGcpResource": { # DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource # The backed up resource is a Google Cloud resource. The word 'DataSource' was included in the names to indicate that this is the representation of the Google Cloud resource used within the DataSource object.
+    "alloyDbClusterDatasourceProperties": { # AlloyDBClusterDataSourceProperties represents the properties of a AlloyDB cluster resource that are stored in the DataSource. . # Output only. AlloyDBClusterDataSourceProperties has a subset of AlloyDB cluster properties that are useful at the Datasource level. Currently none of its child properties are auditable. If new auditable properties are added, the AUDIT annotation should be added.
+      "clusterUid": "A String", # Output only. The cluster UID of the AlloyDB cluster backed up by the datasource.
+      "name": "A String", # Output only. Name of the AlloyDB cluster backed up by the datasource.
+      "pitrWindows": [ # Output only. Point in time recovery windows. The order is guaranteed to be ascending by start time.
+        { # Point in time recovery window for an AlloyDB cluster.
+          "endTime": "A String", # Output only. The end time of the PITR window. It is not set if the corresponding Backup Plan Association is active.
+          "logRetentionDays": "A String", # Output only. Log retention days for the PITR window.
+          "startTime": "A String", # Output only. The start time of the PITR window.
+        },
+      ],
+    },
+    "cloudSqlInstanceDatasourceProperties": { # CloudSqlInstanceDataSourceProperties represents the properties of a Cloud SQL resource that are stored in the DataSource. # Output only. CloudSqlInstanceDataSourceProperties has a subset of Cloud SQL Instance properties that are useful at the Datasource level.
+      "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance.
+      "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+      "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`
+      "name": "A String", # Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance}
+    },
+    "computeInstanceDatasourceProperties": { # ComputeInstanceDataSourceProperties represents the properties of a ComputeEngine resource that are stored in the DataSource. # ComputeInstanceDataSourceProperties has a subset of Compute Instance properties that are useful at the Datasource level.
+      "description": "A String", # The description of the Compute Engine instance.
+      "machineType": "A String", # The machine type of the instance.
+      "name": "A String", # Name of the compute instance backed up by the datasource.
+      "totalDiskCount": "A String", # The total number of disks attached to the Instance.
+      "totalDiskSizeGb": "A String", # The sum of all the disk sizes.
+    },
+    "diskDatasourceProperties": { # DiskDataSourceProperties represents the properties of a Disk resource that are stored in the DataSource. . # DiskDataSourceProperties has a subset of Disk properties that are useful at the Datasource level.
+      "description": "A String", # The description of the disk.
+      "name": "A String", # Name of the disk backed up by the datasource.
+      "sizeGb": "A String", # The size of the disk in GB.
+      "type": "A String", # The type of the disk.
+    },
+    "filestoreInstanceDatasourceProperties": { # FilestoreInstanceDataSourceProperties represents the properties of a Filestore resource that are stored in the DataSource. . # Output only. FilestoreInstanceDataSourceProperties has a subset of FileStore instance properties that are useful at the Datasource level.
+      "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+      "name": "A String", # Output only. Name of the Filestore instance backed up by the datasource.
+    },
+    "gcpResourcename": "A String", # Output only. Full resource pathname URL of the source Google Cloud resource.
+    "location": "A String", # Location of the resource: //"global"/"unspecified".
+    "type": "A String", # The type of the Google Cloud resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.
+  },
+  "etag": "A String", # Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
+  "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined:
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. Identifier. Name of the datasource to create. It must have the format`"projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}"`. `{datasource}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the backup vault.
+  "state": "A String", # Output only. The DataSource resource instance state.
+  "totalStoredBytes": "A String", # The number of bytes (metadata and data) stored in this datasource.
+  "updateTime": "A String", # Output only. The time when the instance was updated.
+}
+
+ +
+ initiateBackup(dataSource, body=None, x__xgafv=None) +
Internal only. Initiates a backup.
+
+Args:
+  dataSource: string, Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # request message for InitiateBackup.
+  "backupId": "A String", # Required. Resource ID of the Backup resource.
+  "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 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:
+
+    { # Response message for InitiateBackup.
+  "backup": "A String", # The name of the backup that was created.
+  "baseBackupGenerationId": 42, # The generation id of the base backup. It is needed for the incremental backups.
+  "newBackupGenerationId": 42, # The generation id of the new backup.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists DataSources in a given project and location.
+
+Args:
+  parent: string, Required. The project and location for which to retrieve data sources information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use "-" for the '{location}' value. (required)
+  filter: string, Optional. Filtering results.
+  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 message for listing DataSources.
+  "dataSources": [ # The list of DataSource instances in the project for the specified location. If the '{location}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return data sources in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.
+    { # Message describing a DataSource object. Datasource object used to represent Datasource details for both admin and basic view.
+      "backupBlockedByVaultAccessRestriction": True or False, # Output only. This field is set to true if the backup is blocked by vault access restriction.
+      "backupConfigInfo": { # BackupConfigInfo has information about how the resource is configured for Backup and about the most recent backup to this vault. # Output only. Details of how the resource is configured for backup.
+        "backupApplianceBackupConfig": { # BackupApplianceBackupConfig captures the backup configuration for applications that are protected by Backup Appliances. # Configuration for an application backed up by a Backup Appliance.
+          "applicationName": "A String", # The name of the application.
+          "backupApplianceId": "A String", # The ID of the backup appliance.
+          "backupApplianceName": "A String", # The name of the backup appliance.
+          "hostName": "A String", # The name of the host where the application is running.
+          "slaId": "A String", # The ID of the SLA of this application.
+          "slpName": "A String", # The name of the SLP associated with the application.
+          "sltName": "A String", # The name of the SLT associated with the application.
+        },
+        "gcpBackupConfig": { # GcpBackupConfig captures the Backup configuration details for Google Cloud resources. All Google Cloud resources regardless of type are protected with backup plan associations. # Configuration for a Google Cloud resource.
+          "autoProtectionPolicyBinding": "A String", # Output only. The resource name of the `AutoProtectionPolicyBinding` that manages this datasource, if any. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}`.
+          "backupPlan": "A String", # The name of the backup plan.
+          "backupPlanAssociation": "A String", # The name of the backup plan association.
+          "backupPlanDescription": "A String", # The description of the backup plan.
+          "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision. E.g. v0, v1 etc.
+          "backupPlanRevisionName": "A String", # The name of the backup plan revision.
+          "backupPlanRules": [ # The names of the backup plan rules which point to this backupvault
+            "A String",
+          ],
+        },
+        "lastBackupError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. If the last backup failed, this field has the error message.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+        "lastBackupState": "A String", # Output only. The status of the last backup to this BackupVault
+        "lastSuccessfulBackupConsistencyTime": "A String", # Output only. If the last backup were successful, this field has the consistency date.
+      },
+      "backupCount": "A String", # Number of backups in the data source.
+      "configState": "A String", # Output only. The backup configuration state.
+      "createTime": "A String", # Output only. The time when the instance was created.
+      "dataSourceBackupApplianceApplication": { # BackupApplianceApplication describes a Source Resource when it is an application backed up by a BackupAppliance. # The backed up resource is a backup appliance application.
+        "applianceId": "A String", # Appliance Id of the Backup Appliance.
+        "applicationId": "A String", # The appid field of the application within the Backup Appliance.
+        "applicationName": "A String", # The name of the Application as known to the Backup Appliance.
+        "backupAppliance": "A String", # Appliance name.
+        "hostId": "A String", # Hostid of the application host.
+        "hostname": "A String", # Hostname of the host where the application is running.
+        "type": "A String", # The type of the application. e.g. VMBackup
+      },
+      "dataSourceGcpResource": { # DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource # The backed up resource is a Google Cloud resource. The word 'DataSource' was included in the names to indicate that this is the representation of the Google Cloud resource used within the DataSource object.
+        "alloyDbClusterDatasourceProperties": { # AlloyDBClusterDataSourceProperties represents the properties of a AlloyDB cluster resource that are stored in the DataSource. . # Output only. AlloyDBClusterDataSourceProperties has a subset of AlloyDB cluster properties that are useful at the Datasource level. Currently none of its child properties are auditable. If new auditable properties are added, the AUDIT annotation should be added.
+          "clusterUid": "A String", # Output only. The cluster UID of the AlloyDB cluster backed up by the datasource.
+          "name": "A String", # Output only. Name of the AlloyDB cluster backed up by the datasource.
+          "pitrWindows": [ # Output only. Point in time recovery windows. The order is guaranteed to be ascending by start time.
+            { # Point in time recovery window for an AlloyDB cluster.
+              "endTime": "A String", # Output only. The end time of the PITR window. It is not set if the corresponding Backup Plan Association is active.
+              "logRetentionDays": "A String", # Output only. Log retention days for the PITR window.
+              "startTime": "A String", # Output only. The start time of the PITR window.
+            },
+          ],
+        },
+        "cloudSqlInstanceDatasourceProperties": { # CloudSqlInstanceDataSourceProperties represents the properties of a Cloud SQL resource that are stored in the DataSource. # Output only. CloudSqlInstanceDataSourceProperties has a subset of Cloud SQL Instance properties that are useful at the Datasource level.
+          "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance.
+          "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+          "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`
+          "name": "A String", # Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance}
+        },
+        "computeInstanceDatasourceProperties": { # ComputeInstanceDataSourceProperties represents the properties of a ComputeEngine resource that are stored in the DataSource. # ComputeInstanceDataSourceProperties has a subset of Compute Instance properties that are useful at the Datasource level.
+          "description": "A String", # The description of the Compute Engine instance.
+          "machineType": "A String", # The machine type of the instance.
+          "name": "A String", # Name of the compute instance backed up by the datasource.
+          "totalDiskCount": "A String", # The total number of disks attached to the Instance.
+          "totalDiskSizeGb": "A String", # The sum of all the disk sizes.
+        },
+        "diskDatasourceProperties": { # DiskDataSourceProperties represents the properties of a Disk resource that are stored in the DataSource. . # DiskDataSourceProperties has a subset of Disk properties that are useful at the Datasource level.
+          "description": "A String", # The description of the disk.
+          "name": "A String", # Name of the disk backed up by the datasource.
+          "sizeGb": "A String", # The size of the disk in GB.
+          "type": "A String", # The type of the disk.
+        },
+        "filestoreInstanceDatasourceProperties": { # FilestoreInstanceDataSourceProperties represents the properties of a Filestore resource that are stored in the DataSource. . # Output only. FilestoreInstanceDataSourceProperties has a subset of FileStore instance properties that are useful at the Datasource level.
+          "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+          "name": "A String", # Output only. Name of the Filestore instance backed up by the datasource.
+        },
+        "gcpResourcename": "A String", # Output only. Full resource pathname URL of the source Google Cloud resource.
+        "location": "A String", # Location of the resource: //"global"/"unspecified".
+        "type": "A String", # The type of the Google Cloud resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.
+      },
+      "etag": "A String", # Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
+      "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined:
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. Name of the datasource to create. It must have the format`"projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}"`. `{datasource}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the backup vault.
+      "state": "A String", # Output only. The DataSource resource instance state.
+      "totalStoredBytes": "A String", # The number of bytes (metadata and data) stored in this datasource.
+      "updateTime": "A String", # Output only. The time when the instance was updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Updates the settings of a DataSource.
+
+Args:
+  name: string, Output only. Identifier. Name of the datasource to create. It must have the format`"projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}"`. `{datasource}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the backup vault. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing a DataSource object. Datasource object used to represent Datasource details for both admin and basic view.
+  "backupBlockedByVaultAccessRestriction": True or False, # Output only. This field is set to true if the backup is blocked by vault access restriction.
+  "backupConfigInfo": { # BackupConfigInfo has information about how the resource is configured for Backup and about the most recent backup to this vault. # Output only. Details of how the resource is configured for backup.
+    "backupApplianceBackupConfig": { # BackupApplianceBackupConfig captures the backup configuration for applications that are protected by Backup Appliances. # Configuration for an application backed up by a Backup Appliance.
+      "applicationName": "A String", # The name of the application.
+      "backupApplianceId": "A String", # The ID of the backup appliance.
+      "backupApplianceName": "A String", # The name of the backup appliance.
+      "hostName": "A String", # The name of the host where the application is running.
+      "slaId": "A String", # The ID of the SLA of this application.
+      "slpName": "A String", # The name of the SLP associated with the application.
+      "sltName": "A String", # The name of the SLT associated with the application.
+    },
+    "gcpBackupConfig": { # GcpBackupConfig captures the Backup configuration details for Google Cloud resources. All Google Cloud resources regardless of type are protected with backup plan associations. # Configuration for a Google Cloud resource.
+      "autoProtectionPolicyBinding": "A String", # Output only. The resource name of the `AutoProtectionPolicyBinding` that manages this datasource, if any. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}`.
+      "backupPlan": "A String", # The name of the backup plan.
+      "backupPlanAssociation": "A String", # The name of the backup plan association.
+      "backupPlanDescription": "A String", # The description of the backup plan.
+      "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision. E.g. v0, v1 etc.
+      "backupPlanRevisionName": "A String", # The name of the backup plan revision.
+      "backupPlanRules": [ # The names of the backup plan rules which point to this backupvault
+        "A String",
+      ],
+    },
+    "lastBackupError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. If the last backup failed, this field has the error message.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+      ],
+      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+    },
+    "lastBackupState": "A String", # Output only. The status of the last backup to this BackupVault
+    "lastSuccessfulBackupConsistencyTime": "A String", # Output only. If the last backup were successful, this field has the consistency date.
+  },
+  "backupCount": "A String", # Number of backups in the data source.
+  "configState": "A String", # Output only. The backup configuration state.
+  "createTime": "A String", # Output only. The time when the instance was created.
+  "dataSourceBackupApplianceApplication": { # BackupApplianceApplication describes a Source Resource when it is an application backed up by a BackupAppliance. # The backed up resource is a backup appliance application.
+    "applianceId": "A String", # Appliance Id of the Backup Appliance.
+    "applicationId": "A String", # The appid field of the application within the Backup Appliance.
+    "applicationName": "A String", # The name of the Application as known to the Backup Appliance.
+    "backupAppliance": "A String", # Appliance name.
+    "hostId": "A String", # Hostid of the application host.
+    "hostname": "A String", # Hostname of the host where the application is running.
+    "type": "A String", # The type of the application. e.g. VMBackup
+  },
+  "dataSourceGcpResource": { # DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource # The backed up resource is a Google Cloud resource. The word 'DataSource' was included in the names to indicate that this is the representation of the Google Cloud resource used within the DataSource object.
+    "alloyDbClusterDatasourceProperties": { # AlloyDBClusterDataSourceProperties represents the properties of a AlloyDB cluster resource that are stored in the DataSource. . # Output only. AlloyDBClusterDataSourceProperties has a subset of AlloyDB cluster properties that are useful at the Datasource level. Currently none of its child properties are auditable. If new auditable properties are added, the AUDIT annotation should be added.
+      "clusterUid": "A String", # Output only. The cluster UID of the AlloyDB cluster backed up by the datasource.
+      "name": "A String", # Output only. Name of the AlloyDB cluster backed up by the datasource.
+      "pitrWindows": [ # Output only. Point in time recovery windows. The order is guaranteed to be ascending by start time.
+        { # Point in time recovery window for an AlloyDB cluster.
+          "endTime": "A String", # Output only. The end time of the PITR window. It is not set if the corresponding Backup Plan Association is active.
+          "logRetentionDays": "A String", # Output only. Log retention days for the PITR window.
+          "startTime": "A String", # Output only. The start time of the PITR window.
+        },
+      ],
+    },
+    "cloudSqlInstanceDatasourceProperties": { # CloudSqlInstanceDataSourceProperties represents the properties of a Cloud SQL resource that are stored in the DataSource. # Output only. CloudSqlInstanceDataSourceProperties has a subset of Cloud SQL Instance properties that are useful at the Datasource level.
+      "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance.
+      "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+      "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`
+      "name": "A String", # Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance}
+    },
+    "computeInstanceDatasourceProperties": { # ComputeInstanceDataSourceProperties represents the properties of a ComputeEngine resource that are stored in the DataSource. # ComputeInstanceDataSourceProperties has a subset of Compute Instance properties that are useful at the Datasource level.
+      "description": "A String", # The description of the Compute Engine instance.
+      "machineType": "A String", # The machine type of the instance.
+      "name": "A String", # Name of the compute instance backed up by the datasource.
+      "totalDiskCount": "A String", # The total number of disks attached to the Instance.
+      "totalDiskSizeGb": "A String", # The sum of all the disk sizes.
+    },
+    "diskDatasourceProperties": { # DiskDataSourceProperties represents the properties of a Disk resource that are stored in the DataSource. . # DiskDataSourceProperties has a subset of Disk properties that are useful at the Datasource level.
+      "description": "A String", # The description of the disk.
+      "name": "A String", # Name of the disk backed up by the datasource.
+      "sizeGb": "A String", # The size of the disk in GB.
+      "type": "A String", # The type of the disk.
+    },
+    "filestoreInstanceDatasourceProperties": { # FilestoreInstanceDataSourceProperties represents the properties of a Filestore resource that are stored in the DataSource. . # Output only. FilestoreInstanceDataSourceProperties has a subset of FileStore instance properties that are useful at the Datasource level.
+      "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+      "name": "A String", # Output only. Name of the Filestore instance backed up by the datasource.
+    },
+    "gcpResourcename": "A String", # Output only. Full resource pathname URL of the source Google Cloud resource.
+    "location": "A String", # Location of the resource: //"global"/"unspecified".
+    "type": "A String", # The type of the Google Cloud resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.
+  },
+  "etag": "A String", # Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
+  "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined:
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. Identifier. Name of the datasource to create. It must have the format`"projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}"`. `{datasource}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the backup vault.
+  "state": "A String", # Output only. The DataSource resource instance state.
+  "totalStoredBytes": "A String", # The number of bytes (metadata and data) stored in this datasource.
+  "updateTime": "A String", # Output only. The time when the instance was updated.
+}
+
+  allowMissing: boolean, Optional. Enable upsert.
+  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, Required. Field mask is used to specify the fields to be overwritten in the DataSource 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 the 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:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ remove(name, body=None, x__xgafv=None) +
Deletes a DataSource. This is a custom method instead of a standard delete method because external clients will not delete DataSources except for BackupDR backup appliances.
+
+Args:
+  name: string, Required. Name of the resource. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for deleting a DataSource.
+  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ setInternalStatus(dataSource, body=None, x__xgafv=None) +
Sets the internal status of a DataSource.
+
+Args:
+  dataSource: string, Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SetStatusInternal method.
+  "backupConfigState": "A String", # Required. Output only. The new BackupConfigState to set for the DataSource.
+  "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).
+  "value": "A String", # Required. The value required for this method to work. This field must be the 32-byte SHA256 hash of the DataSourceID. The DataSourceID used here is only the final piece of the fully qualified resource path for this DataSource (i.e. the part after '.../dataSources/'). This field exists to make this method difficult to call since it is intended for use only by Backup Appliances.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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/backupdr_v1beta.projects.locations.backupVaults.html b/docs/dyn/backupdr_v1beta.projects.locations.backupVaults.html new file mode 100644 index 0000000000..c6a6e93bf3 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.locations.backupVaults.html @@ -0,0 +1,515 @@ + + + +

Backup and DR Service API . projects . locations . backupVaults

+

Instance Methods

+

+ dataSources() +

+

Returns the dataSources Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(parent, backupVaultId=None, body=None, requestId=None, validateOnly=None, x__xgafv=None)

+

Creates a new BackupVault in a given project and location.

+

+ delete(name, allowMissing=None, etag=None, force=None, ignoreBackupPlanReferences=None, requestId=None, validateOnly=None, x__xgafv=None)

+

Deletes a BackupVault.

+

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

+

FetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission.

+

+ fetchUsable_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Gets details of a BackupVault.

+

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

+

Lists BackupVaults in a given project and location.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates the settings of a BackupVault.

+

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

+

Returns the caller's permissions on a BackupVault resource. A caller is not required to have Google IAM permission to make this request.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, backupVaultId=None, body=None, requestId=None, validateOnly=None, x__xgafv=None) +
Creates a new BackupVault in a given project and location.
+
+Args:
+  parent: string, Required. Value for parent. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing a BackupVault object.
+  "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",
+  },
+  "backupCount": "A String", # Output only. The number of backups in this backup vault.
+  "backupMinimumEnforcedRetentionDuration": "A String", # Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. Note: Longer minimum enforced retention period impacts potential storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.
+  "backupRetentionInheritance": "A String", # Optional. Setting for how a backup's enforced retention end time is inherited.
+  "createTime": "A String", # Output only. The time when the instance was created.
+  "deletable": True or False, # Output only. Set to true when there are no backups nested under this resource.
+  "description": "A String", # Optional. The description of the BackupVault instance (2048 characters or less).
+  "effectiveTime": "A String", # Optional. Time after which the BackupVault resource is locked.
+  "encryptionConfig": { # Message describing the EncryptionConfig of backup vault. This determines how data within the vault is encrypted at rest. # Optional. The encryption config of the backup vault.
+    "kmsKeyName": "A String", # Optional. The Cloud KMS key name to encrypt backups in this backup vault. Must be in the same region as the vault. Some workload backups like compute disk backups may use their inherited source key instead. Format: projects/{project}/locations/{location}/keyRings/{ring}/cryptoKeys/{key}
+  },
+  "etag": "A String", # Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
+  "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined:
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. Identifier. Name of the backup vault to create. It must have the format`"projects/{project}/locations/{location}/backupVaults/{backupvault}"`. `{backupvault}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.
+  "serviceAccount": "A String", # Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
+  "state": "A String", # Output only. The BackupVault resource instance state.
+  "totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources.
+  "uid": "A String", # Output only. Immutable after resource creation until resource deletion.
+  "updateTime": "A String", # Output only. The time when the instance was updated.
+}
+
+  backupVaultId: string, Required. ID of the requesting object If auto-generating ID server-side, remove this field and backup_vault_id from the method_signature of Create RPC
+  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).
+  validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is 'false'.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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, allowMissing=None, etag=None, force=None, ignoreBackupPlanReferences=None, requestId=None, validateOnly=None, x__xgafv=None) +
Deletes a BackupVault.
+
+Args:
+  name: string, Required. Name of the resource. (required)
+  allowMissing: boolean, Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken.
+  etag: string, The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked.
+  force: boolean, Optional. If set to true, any data source from this backup vault will also be deleted.
+  ignoreBackupPlanReferences: boolean, Optional. If set to true, backupvault deletion will proceed even if there are backup plans referencing the backupvault. The default is 'false'.
+  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).
+  validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is 'false'.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ fetchUsable(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
FetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission.
+
+Args:
+  parent: string, Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use "-" for the '{location}' value. (required)
+  filter: string, Optional. Filtering results.
+  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 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. 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",
+      },
+      "backupCount": "A String", # Output only. The number of backups in this backup vault.
+      "backupMinimumEnforcedRetentionDuration": "A String", # Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. Note: Longer minimum enforced retention period impacts potential storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.
+      "backupRetentionInheritance": "A String", # Optional. Setting for how a backup's enforced retention end time is inherited.
+      "createTime": "A String", # Output only. The time when the instance was created.
+      "deletable": True or False, # Output only. Set to true when there are no backups nested under this resource.
+      "description": "A String", # Optional. The description of the BackupVault instance (2048 characters or less).
+      "effectiveTime": "A String", # Optional. Time after which the BackupVault resource is locked.
+      "encryptionConfig": { # Message describing the EncryptionConfig of backup vault. This determines how data within the vault is encrypted at rest. # Optional. The encryption config of the backup vault.
+        "kmsKeyName": "A String", # Optional. The Cloud KMS key name to encrypt backups in this backup vault. Must be in the same region as the vault. Some workload backups like compute disk backups may use their inherited source key instead. Format: projects/{project}/locations/{location}/keyRings/{ring}/cryptoKeys/{key}
+      },
+      "etag": "A String", # Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
+      "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined:
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. Name of the backup vault to create. It must have the format`"projects/{project}/locations/{location}/backupVaults/{backupvault}"`. `{backupvault}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.
+      "serviceAccount": "A String", # Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
+      "state": "A String", # Output only. The BackupVault resource instance state.
+      "totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources.
+      "uid": "A String", # Output only. Immutable after resource creation until resource deletion.
+      "updateTime": "A String", # Output only. The time when the instance was updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ fetchUsable_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ get(name, view=None, x__xgafv=None) +
Gets details of a BackupVault.
+
+Args:
+  name: string, Required. Name of the backupvault store resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}' (required)
+  view: string, Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault
+    Allowed values
+      BACKUP_VAULT_VIEW_UNSPECIFIED - If the value is not set, the default 'FULL' view is used.
+      BACKUP_VAULT_VIEW_BASIC - Includes basic data about the Backup Vault, but not the full contents.
+      BACKUP_VAULT_VIEW_FULL - Includes all data about the Backup Vault. This is the default value (for both ListBackupVaults and GetBackupVault).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing a BackupVault object.
+  "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",
+  },
+  "backupCount": "A String", # Output only. The number of backups in this backup vault.
+  "backupMinimumEnforcedRetentionDuration": "A String", # Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. Note: Longer minimum enforced retention period impacts potential storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.
+  "backupRetentionInheritance": "A String", # Optional. Setting for how a backup's enforced retention end time is inherited.
+  "createTime": "A String", # Output only. The time when the instance was created.
+  "deletable": True or False, # Output only. Set to true when there are no backups nested under this resource.
+  "description": "A String", # Optional. The description of the BackupVault instance (2048 characters or less).
+  "effectiveTime": "A String", # Optional. Time after which the BackupVault resource is locked.
+  "encryptionConfig": { # Message describing the EncryptionConfig of backup vault. This determines how data within the vault is encrypted at rest. # Optional. The encryption config of the backup vault.
+    "kmsKeyName": "A String", # Optional. The Cloud KMS key name to encrypt backups in this backup vault. Must be in the same region as the vault. Some workload backups like compute disk backups may use their inherited source key instead. Format: projects/{project}/locations/{location}/keyRings/{ring}/cryptoKeys/{key}
+  },
+  "etag": "A String", # Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
+  "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined:
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. Identifier. Name of the backup vault to create. It must have the format`"projects/{project}/locations/{location}/backupVaults/{backupvault}"`. `{backupvault}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.
+  "serviceAccount": "A String", # Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
+  "state": "A String", # Output only. The BackupVault resource instance state.
+  "totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources.
+  "uid": "A String", # Output only. Immutable after resource creation until resource deletion.
+  "updateTime": "A String", # Output only. The time when the instance was updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) +
Lists BackupVaults in a given project and location.
+
+Args:
+  parent: string, Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use "-" for the '{location}' value. (required)
+  filter: string, Optional. Filtering results.
+  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.
+  view: string, Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault.
+    Allowed values
+      BACKUP_VAULT_VIEW_UNSPECIFIED - If the value is not set, the default 'FULL' view is used.
+      BACKUP_VAULT_VIEW_BASIC - Includes basic data about the Backup Vault, but not the full contents.
+      BACKUP_VAULT_VIEW_FULL - Includes all data about the Backup Vault. This is the default value (for both ListBackupVaults and GetBackupVault).
+  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 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. 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",
+      },
+      "backupCount": "A String", # Output only. The number of backups in this backup vault.
+      "backupMinimumEnforcedRetentionDuration": "A String", # Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. Note: Longer minimum enforced retention period impacts potential storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.
+      "backupRetentionInheritance": "A String", # Optional. Setting for how a backup's enforced retention end time is inherited.
+      "createTime": "A String", # Output only. The time when the instance was created.
+      "deletable": True or False, # Output only. Set to true when there are no backups nested under this resource.
+      "description": "A String", # Optional. The description of the BackupVault instance (2048 characters or less).
+      "effectiveTime": "A String", # Optional. Time after which the BackupVault resource is locked.
+      "encryptionConfig": { # Message describing the EncryptionConfig of backup vault. This determines how data within the vault is encrypted at rest. # Optional. The encryption config of the backup vault.
+        "kmsKeyName": "A String", # Optional. The Cloud KMS key name to encrypt backups in this backup vault. Must be in the same region as the vault. Some workload backups like compute disk backups may use their inherited source key instead. Format: projects/{project}/locations/{location}/keyRings/{ring}/cryptoKeys/{key}
+      },
+      "etag": "A String", # Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
+      "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined:
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. Name of the backup vault to create. It must have the format`"projects/{project}/locations/{location}/backupVaults/{backupvault}"`. `{backupvault}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.
+      "serviceAccount": "A String", # Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
+      "state": "A String", # Output only. The BackupVault resource instance state.
+      "totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources.
+      "uid": "A String", # Output only. Immutable after resource creation until resource deletion.
+      "updateTime": "A String", # Output only. The time when the instance was updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, force=None, forceUpdateAccessRestriction=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None) +
Updates the settings of a BackupVault.
+
+Args:
+  name: string, Output only. Identifier. Name of the backup vault to create. It must have the format`"projects/{project}/locations/{location}/backupVaults/{backupvault}"`. `{backupvault}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing a BackupVault object.
+  "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",
+  },
+  "backupCount": "A String", # Output only. The number of backups in this backup vault.
+  "backupMinimumEnforcedRetentionDuration": "A String", # Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. Note: Longer minimum enforced retention period impacts potential storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.
+  "backupRetentionInheritance": "A String", # Optional. Setting for how a backup's enforced retention end time is inherited.
+  "createTime": "A String", # Output only. The time when the instance was created.
+  "deletable": True or False, # Output only. Set to true when there are no backups nested under this resource.
+  "description": "A String", # Optional. The description of the BackupVault instance (2048 characters or less).
+  "effectiveTime": "A String", # Optional. Time after which the BackupVault resource is locked.
+  "encryptionConfig": { # Message describing the EncryptionConfig of backup vault. This determines how data within the vault is encrypted at rest. # Optional. The encryption config of the backup vault.
+    "kmsKeyName": "A String", # Optional. The Cloud KMS key name to encrypt backups in this backup vault. Must be in the same region as the vault. Some workload backups like compute disk backups may use their inherited source key instead. Format: projects/{project}/locations/{location}/keyRings/{ring}/cryptoKeys/{key}
+  },
+  "etag": "A String", # Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
+  "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined:
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. Identifier. Name of the backup vault to create. It must have the format`"projects/{project}/locations/{location}/backupVaults/{backupvault}"`. `{backupvault}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.
+  "serviceAccount": "A String", # Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
+  "state": "A String", # Output only. The BackupVault resource instance state.
+  "totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources.
+  "uid": "A String", # Output only. Immutable after resource creation until resource deletion.
+  "updateTime": "A String", # Output only. The time when the instance was updated.
+}
+
+  force: boolean, Optional. If set to true, will not check plan duration against backup vault enforcement duration.
+  forceUpdateAccessRestriction: boolean, Optional. If set to true, we will force update access restriction even if some non compliant data sources are present. The default is 'false'.
+  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, Required. Field mask is used to specify the fields to be overwritten in the BackupVault 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 the request will fail.
+  validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is 'false'.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns the caller's permissions on a BackupVault resource. A caller is not required to have Google IAM permission to make this request.
+
+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",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1beta.projects.locations.dataSourceReferences.html b/docs/dyn/backupdr_v1beta.projects.locations.dataSourceReferences.html new file mode 100644 index 0000000000..38fa559cb3 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.locations.dataSourceReferences.html @@ -0,0 +1,289 @@ + + + +

Backup and DR Service API . projects . locations . dataSourceReferences

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Fetch DataSourceReferences for a given project, location and resource type.

+

+ fetchForResourceType_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ get(name, x__xgafv=None)

+

Gets details of a single DataSourceReference.

+

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

+

Lists DataSourceReferences for a given project and location.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ fetchForResourceType(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, resourceType=None, x__xgafv=None) +
Fetch DataSourceReferences for a given project, location and resource type.
+
+Args:
+  parent: string, Required. The parent resource name. Format: projects/{project}/locations/{location} (required)
+  filter: string, Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields: * data_source * data_source_gcp_resource_info.gcp_resourcename * data_source_backup_config_state * data_source_backup_count * data_source_backup_config_info.last_backup_state * data_source_gcp_resource_info.gcp_resourcename * data_source_gcp_resource_info.type * data_source_gcp_resource_info.location * data_source_gcp_resource_info.cloud_sql_instance_properties.instance_create_time
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * name
+  pageSize: integer, Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+  pageToken: string, Optional. A page token, received from a previous call of `FetchDataSourceReferencesForResourceType`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDataSourceReferencesForResourceType` must match the call that provided the page token.
+  resourceType: string, Required. The type of the Google Cloud resource. Ex: sql.googleapis.com/Instance
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the FetchDataSourceReferencesForResourceType method.
+  "dataSourceReferences": [ # The DataSourceReferences from the specified parent.
+    { # DataSourceReference is a reference to a DataSource resource.
+      "createTime": "A String", # Output only. The time when the DataSourceReference was created.
+      "dataSource": "A String", # Output only. The resource name of the DataSource. Format: projects/{project}/locations/{location}/backupVaults/{backupVault}/dataSources/{dataSource}
+      "dataSourceBackupConfigInfo": { # Information of backup configuration on the DataSource. # Output only. Information of backup configuration on the DataSource.
+        "lastBackupState": "A String", # Output only. The status of the last backup in this DataSource
+        "lastSuccessfulBackupConsistencyTime": "A String", # Output only. Timestamp of the last successful backup to this DataSource.
+      },
+      "dataSourceBackupConfigState": "A String", # Output only. The backup configuration state of the DataSource.
+      "dataSourceBackupCount": "A String", # Output only. Number of backups in the DataSource.
+      "dataSourceGcpResourceInfo": { # The Google Cloud resource that the DataSource is associated with. # Output only. The Google Cloud resource that the DataSource is associated with.
+        "alloyDbClusterProperties": { # AlloyDBClusterDataSourceReferenceProperties represents the properties of an AlloyDB cluster that are stored in the DataSourceReference. # Output only. The properties of the AlloyDB cluster.
+          "name": "A String", # Output only. Name of the AlloyDB cluster backed up by the datasource. Format: projects/{project}/locations/{location}/clusters/{cluster}
+        },
+        "cloudSqlInstanceProperties": { # CloudSqlInstanceDataSourceReferenceProperties represents the properties of a Cloud SQL resource that are stored in the DataSourceReference. # Output only. The properties of the Cloud SQL instance.
+          "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance.
+          "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+          "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`
+          "name": "A String", # Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance}
+        },
+        "filestoreInstanceProperties": { # FilestoreInstanceDataSourceReferenceProperties represents the properties of a Filestore resource that are stored in the DataSourceReference. . # Output only. The properties of the Filestore instance.
+          "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+          "name": "A String", # Output only. Name of the Filestore instance backed up by the datasource. Format: projects/{project}/instances/{instance}
+        },
+        "gcpResourcename": "A String", # Output only. The resource name of the Google Cloud resource. Ex: projects/{project}/zones/{zone}/instances/{instance}
+        "location": "A String", # Output only. The location of the Google Cloud resource. Ex: //"global"/"unspecified"
+        "type": "A String", # Output only. The type of the Google Cloud resource. Ex: compute.googleapis.com/Instance
+      },
+      "name": "A String", # Identifier. The resource name of the DataSourceReference. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}
+      "totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources for the referenced datasource.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ fetchForResourceType_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single DataSourceReference.
+
+Args:
+  name: string, Required. The name of the DataSourceReference to retrieve. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # DataSourceReference is a reference to a DataSource resource.
+  "createTime": "A String", # Output only. The time when the DataSourceReference was created.
+  "dataSource": "A String", # Output only. The resource name of the DataSource. Format: projects/{project}/locations/{location}/backupVaults/{backupVault}/dataSources/{dataSource}
+  "dataSourceBackupConfigInfo": { # Information of backup configuration on the DataSource. # Output only. Information of backup configuration on the DataSource.
+    "lastBackupState": "A String", # Output only. The status of the last backup in this DataSource
+    "lastSuccessfulBackupConsistencyTime": "A String", # Output only. Timestamp of the last successful backup to this DataSource.
+  },
+  "dataSourceBackupConfigState": "A String", # Output only. The backup configuration state of the DataSource.
+  "dataSourceBackupCount": "A String", # Output only. Number of backups in the DataSource.
+  "dataSourceGcpResourceInfo": { # The Google Cloud resource that the DataSource is associated with. # Output only. The Google Cloud resource that the DataSource is associated with.
+    "alloyDbClusterProperties": { # AlloyDBClusterDataSourceReferenceProperties represents the properties of an AlloyDB cluster that are stored in the DataSourceReference. # Output only. The properties of the AlloyDB cluster.
+      "name": "A String", # Output only. Name of the AlloyDB cluster backed up by the datasource. Format: projects/{project}/locations/{location}/clusters/{cluster}
+    },
+    "cloudSqlInstanceProperties": { # CloudSqlInstanceDataSourceReferenceProperties represents the properties of a Cloud SQL resource that are stored in the DataSourceReference. # Output only. The properties of the Cloud SQL instance.
+      "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance.
+      "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+      "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`
+      "name": "A String", # Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance}
+    },
+    "filestoreInstanceProperties": { # FilestoreInstanceDataSourceReferenceProperties represents the properties of a Filestore resource that are stored in the DataSourceReference. . # Output only. The properties of the Filestore instance.
+      "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+      "name": "A String", # Output only. Name of the Filestore instance backed up by the datasource. Format: projects/{project}/instances/{instance}
+    },
+    "gcpResourcename": "A String", # Output only. The resource name of the Google Cloud resource. Ex: projects/{project}/zones/{zone}/instances/{instance}
+    "location": "A String", # Output only. The location of the Google Cloud resource. Ex: //"global"/"unspecified"
+    "type": "A String", # Output only. The type of the Google Cloud resource. Ex: compute.googleapis.com/Instance
+  },
+  "name": "A String", # Identifier. The resource name of the DataSourceReference. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}
+  "totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources for the referenced datasource.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists DataSourceReferences for a given project and location.
+
+Args:
+  parent: string, Required. The parent resource name. Format: projects/{project}/locations/{location} (required)
+  filter: string, Optional. A filter expression that filters the results listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The following field and operator combinations are supported: * data_source_gcp_resource_info.gcp_resourcename with `=`, `!=` * data_source_gcp_resource_info.type with `=`, `!=`
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * data_source * data_source_gcp_resource_info.gcp_resourcename
+  pageSize: integer, Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+  pageToken: string, Optional. A page token, received from a previous `ListDataSourceReferences` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataSourceReferences` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the ListDataSourceReferences method.
+  "dataSourceReferences": [ # The DataSourceReferences from the specified parent.
+    { # DataSourceReference is a reference to a DataSource resource.
+      "createTime": "A String", # Output only. The time when the DataSourceReference was created.
+      "dataSource": "A String", # Output only. The resource name of the DataSource. Format: projects/{project}/locations/{location}/backupVaults/{backupVault}/dataSources/{dataSource}
+      "dataSourceBackupConfigInfo": { # Information of backup configuration on the DataSource. # Output only. Information of backup configuration on the DataSource.
+        "lastBackupState": "A String", # Output only. The status of the last backup in this DataSource
+        "lastSuccessfulBackupConsistencyTime": "A String", # Output only. Timestamp of the last successful backup to this DataSource.
+      },
+      "dataSourceBackupConfigState": "A String", # Output only. The backup configuration state of the DataSource.
+      "dataSourceBackupCount": "A String", # Output only. Number of backups in the DataSource.
+      "dataSourceGcpResourceInfo": { # The Google Cloud resource that the DataSource is associated with. # Output only. The Google Cloud resource that the DataSource is associated with.
+        "alloyDbClusterProperties": { # AlloyDBClusterDataSourceReferenceProperties represents the properties of an AlloyDB cluster that are stored in the DataSourceReference. # Output only. The properties of the AlloyDB cluster.
+          "name": "A String", # Output only. Name of the AlloyDB cluster backed up by the datasource. Format: projects/{project}/locations/{location}/clusters/{cluster}
+        },
+        "cloudSqlInstanceProperties": { # CloudSqlInstanceDataSourceReferenceProperties represents the properties of a Cloud SQL resource that are stored in the DataSourceReference. # Output only. The properties of the Cloud SQL instance.
+          "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance.
+          "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+          "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`
+          "name": "A String", # Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance}
+        },
+        "filestoreInstanceProperties": { # FilestoreInstanceDataSourceReferenceProperties represents the properties of a Filestore resource that are stored in the DataSourceReference. . # Output only. The properties of the Filestore instance.
+          "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+          "name": "A String", # Output only. Name of the Filestore instance backed up by the datasource. Format: projects/{project}/instances/{instance}
+        },
+        "gcpResourcename": "A String", # Output only. The resource name of the Google Cloud resource. Ex: projects/{project}/zones/{zone}/instances/{instance}
+        "location": "A String", # Output only. The location of the Google Cloud resource. Ex: //"global"/"unspecified"
+        "type": "A String", # Output only. The type of the Google Cloud resource. Ex: compute.googleapis.com/Instance
+      },
+      "name": "A String", # Identifier. The resource name of the DataSourceReference. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}
+      "totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources for the referenced datasource.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1beta.projects.locations.html b/docs/dyn/backupdr_v1beta.projects.locations.html new file mode 100644 index 0000000000..82988baf60 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.locations.html @@ -0,0 +1,253 @@ + + + +

Backup and DR Service API . projects . locations

+

Instance Methods

+

+ appliedAutoProtectionPolicies() +

+

Returns the appliedAutoProtectionPolicies Resource.

+ +

+ autoProtectionPolicies() +

+

Returns the autoProtectionPolicies Resource.

+ +

+ backupPlanAssociations() +

+

Returns the backupPlanAssociations Resource.

+ +

+ backupPlans() +

+

Returns the backupPlans Resource.

+ +

+ backupVaults() +

+

Returns the backupVaults Resource.

+ +

+ dataSourceReferences() +

+

Returns the dataSourceReferences Resource.

+ +

+ managementServers() +

+

Returns the managementServers Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ resourceBackupConfigs() +

+

Returns the resourceBackupConfigs Resource.

+ +

+ serviceConfig() +

+

Returns the serviceConfig Resource.

+ +

+ trial() +

+

Returns the trial Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets information about a location.

+

+ getTrial(name, x__xgafv=None)

+

Gets the Trial state for a given project

+

+ 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(previous_request, previous_response)

+

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"`
+}
+
+ +
+ getTrial(name, x__xgafv=None) +
Gets the Trial state for a given project
+
+Args:
+  name: string, Required. The project for which trial details need to be retrieved. Format: projects/{project}/locations/{location} Supported Locations are - us, eu and asia. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Trial for a project.
+  "endReason": "A String", # Output only. The reason for ending the trial.
+  "endTime": "A String", # Output only. The time when the trial will expire.
+  "name": "A String", # Identifier. The resource name of the trial. Format: projects/{project}/locations/{location}/trial
+  "startTime": "A String", # Output only. The time when the trial was subscribed.
+  "state": "A String", # Output only. The state of the trial.
+}
+
+ +
+ 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(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1beta.projects.locations.managementServers.html b/docs/dyn/backupdr_v1beta.projects.locations.managementServers.html new file mode 100644 index 0000000000..7937df586b --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.locations.managementServers.html @@ -0,0 +1,545 @@ + + + +

Backup and DR Service API . projects . locations . managementServers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new ManagementServer in a given project and location.

+

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

+

Deletes a single ManagementServer.

+

+ get(name, x__xgafv=None)

+

Gets details of a single ManagementServer.

+

+ 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, x__xgafv=None)

+

Lists ManagementServers in a given project and location.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Returns the Assured Workloads compliance metadata for a given project.

+

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

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, managementServerId=None, requestId=None, x__xgafv=None) +
Creates a new ManagementServer in a given project and location.
+
+Args:
+  parent: string, Required. The management server project and location in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR locations map to Google Cloud regions, for example **us-central1**. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # ManagementServer describes a single BackupDR ManagementServer instance.
+  "baProxyUri": [ # Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The time when the instance was created.
+  "description": "A String", # Optional. The description of the ManagementServer instance (2048 characters or less).
+  "etag": "A String", # Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
+  "labels": { # Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go= If set to true, the MS is created in migration ready mode.
+    "a_key": "A String",
+  },
+  "managementUri": { # ManagementURI for the Management Server resource. # Output only. The hostname or ip address of the exposed AGM endpoints, used by clients to connect to AGM/RD graphical user interface and APIs.
+    "api": "A String", # Output only. The ManagementServer AGM/RD API URL.
+    "webUi": "A String", # Output only. The ManagementServer AGM/RD WebUI URL.
+  },
+  "name": "A String", # Output only. Identifier. The resource name.
+  "networks": [ # Optional. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported. This field is optional if MS is created without PSA
+    { # Network configuration for ManagementServer instance.
+      "network": "A String", # Optional. The resource name of the Google Compute Engine VPC network to which the ManagementServer instance is connected.
+      "peeringMode": "A String", # Optional. The network connect mode of the ManagementServer instance. For this version, only PRIVATE_SERVICE_ACCESS is supported.
+    },
+  ],
+  "oauth2ClientId": "A String", # Output only. The OAuth 2.0 client id is required to make API calls to the Backup and DR instance API of this ManagementServer. This is the value that should be provided in the 'aud' field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken).
+  "satisfiesPzi": True or False, # Output only. Reserved for future use.
+  "satisfiesPzs": True or False, # Output only. Reserved for future use.
+  "state": "A String", # Output only. The ManagementServer state.
+  "type": "A String", # Optional. The type of the ManagementServer resource.
+  "updateTime": "A String", # Output only. The time when the instance was updated.
+  "workforceIdentityBasedManagementUri": { # ManagementURI depending on the Workforce Identity i.e. either 1p or 3p. # Output only. The hostnames of the exposed AGM endpoints for both types of user i.e. 1p and 3p, used to connect AGM/RM UI.
+    "firstPartyManagementUri": "A String", # Output only. First party Management URI for Google Identities.
+    "thirdPartyManagementUri": "A String", # Output only. Third party Management URI for External Identity Providers.
+  },
+  "workforceIdentityBasedOauth2ClientId": { # OAuth Client ID depending on the Workforce Identity i.e. either 1p or 3p, # Output only. The OAuth client IDs for both types of user i.e. 1p and 3p.
+    "firstPartyOauth2ClientId": "A String", # Output only. First party OAuth Client ID for Google Identities.
+    "thirdPartyOauth2ClientId": "A String", # Output only. Third party OAuth Client ID for External Identity Providers.
+  },
+}
+
+  managementServerId: string, Required. The name of the management server to create. The name must be unique for the specified project and location.
+  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:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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 single ManagementServer.
+
+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:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if 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 ManagementServer.
+
+Args:
+  name: string, Required. Name of the management server resource name, in the format 'projects/{project_id}/locations/{location}/managementServers/{resource_name}' (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ManagementServer describes a single BackupDR ManagementServer instance.
+  "baProxyUri": [ # Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. The time when the instance was created.
+  "description": "A String", # Optional. The description of the ManagementServer instance (2048 characters or less).
+  "etag": "A String", # Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
+  "labels": { # Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go= If set to true, the MS is created in migration ready mode.
+    "a_key": "A String",
+  },
+  "managementUri": { # ManagementURI for the Management Server resource. # Output only. The hostname or ip address of the exposed AGM endpoints, used by clients to connect to AGM/RD graphical user interface and APIs.
+    "api": "A String", # Output only. The ManagementServer AGM/RD API URL.
+    "webUi": "A String", # Output only. The ManagementServer AGM/RD WebUI URL.
+  },
+  "name": "A String", # Output only. Identifier. The resource name.
+  "networks": [ # Optional. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported. This field is optional if MS is created without PSA
+    { # Network configuration for ManagementServer instance.
+      "network": "A String", # Optional. The resource name of the Google Compute Engine VPC network to which the ManagementServer instance is connected.
+      "peeringMode": "A String", # Optional. The network connect mode of the ManagementServer instance. For this version, only PRIVATE_SERVICE_ACCESS is supported.
+    },
+  ],
+  "oauth2ClientId": "A String", # Output only. The OAuth 2.0 client id is required to make API calls to the Backup and DR instance API of this ManagementServer. This is the value that should be provided in the 'aud' field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken).
+  "satisfiesPzi": True or False, # Output only. Reserved for future use.
+  "satisfiesPzs": True or False, # Output only. Reserved for future use.
+  "state": "A String", # Output only. The ManagementServer state.
+  "type": "A String", # Optional. The type of the ManagementServer resource.
+  "updateTime": "A String", # Output only. The time when the instance was updated.
+  "workforceIdentityBasedManagementUri": { # ManagementURI depending on the Workforce Identity i.e. either 1p or 3p. # Output only. The hostnames of the exposed AGM endpoints for both types of user i.e. 1p and 3p, used to connect AGM/RM UI.
+    "firstPartyManagementUri": "A String", # Output only. First party Management URI for Google Identities.
+    "thirdPartyManagementUri": "A String", # Output only. Third party Management URI for External Identity Providers.
+  },
+  "workforceIdentityBasedOauth2ClientId": { # OAuth Client ID depending on the Workforce Identity i.e. either 1p or 3p, # Output only. The OAuth client IDs for both types of user i.e. 1p and 3p.
+    "firstPartyOauth2ClientId": "A String", # Output only. First party OAuth Client ID for Google Identities.
+    "thirdPartyOauth2ClientId": "A String", # Output only. Third party OAuth Client ID for External Identity Providers.
+  },
+}
+
+ +
+ 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, x__xgafv=None) +
Lists ManagementServers in a given project and location.
+
+Args:
+  parent: string, Required. The project and location for which to retrieve management servers information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve management servers for all locations, use "-" for the '{location}' value. (required)
+  filter: string, Optional. Filtering results.
+  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 message for listing management servers.
+  "managementServers": [ # The list of ManagementServer 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 management servers in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.
+    { # ManagementServer describes a single BackupDR ManagementServer instance.
+      "baProxyUri": [ # Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
+        "A String",
+      ],
+      "createTime": "A String", # Output only. The time when the instance was created.
+      "description": "A String", # Optional. The description of the ManagementServer instance (2048 characters or less).
+      "etag": "A String", # Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
+      "labels": { # Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go= If set to true, the MS is created in migration ready mode.
+        "a_key": "A String",
+      },
+      "managementUri": { # ManagementURI for the Management Server resource. # Output only. The hostname or ip address of the exposed AGM endpoints, used by clients to connect to AGM/RD graphical user interface and APIs.
+        "api": "A String", # Output only. The ManagementServer AGM/RD API URL.
+        "webUi": "A String", # Output only. The ManagementServer AGM/RD WebUI URL.
+      },
+      "name": "A String", # Output only. Identifier. The resource name.
+      "networks": [ # Optional. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported. This field is optional if MS is created without PSA
+        { # Network configuration for ManagementServer instance.
+          "network": "A String", # Optional. The resource name of the Google Compute Engine VPC network to which the ManagementServer instance is connected.
+          "peeringMode": "A String", # Optional. The network connect mode of the ManagementServer instance. For this version, only PRIVATE_SERVICE_ACCESS is supported.
+        },
+      ],
+      "oauth2ClientId": "A String", # Output only. The OAuth 2.0 client id is required to make API calls to the Backup and DR instance API of this ManagementServer. This is the value that should be provided in the 'aud' field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken).
+      "satisfiesPzi": True or False, # Output only. Reserved for future use.
+      "satisfiesPzs": True or False, # Output only. Reserved for future use.
+      "state": "A String", # Output only. The ManagementServer state.
+      "type": "A String", # Optional. The type of the ManagementServer resource.
+      "updateTime": "A String", # Output only. The time when the instance was updated.
+      "workforceIdentityBasedManagementUri": { # ManagementURI depending on the Workforce Identity i.e. either 1p or 3p. # Output only. The hostnames of the exposed AGM endpoints for both types of user i.e. 1p and 3p, used to connect AGM/RM UI.
+        "firstPartyManagementUri": "A String", # Output only. First party Management URI for Google Identities.
+        "thirdPartyManagementUri": "A String", # Output only. Third party Management URI for External Identity Providers.
+      },
+      "workforceIdentityBasedOauth2ClientId": { # OAuth Client ID depending on the Workforce Identity i.e. either 1p or 3p, # Output only. The OAuth client IDs for both types of user i.e. 1p and 3p.
+        "firstPartyOauth2ClientId": "A String", # Output only. First party OAuth Client ID for Google Identities.
+        "thirdPartyOauth2ClientId": "A String", # Output only. Third party OAuth Client ID for External Identity Providers.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ msComplianceMetadata(parent, body=None, x__xgafv=None) +
Returns the Assured Workloads compliance metadata for a given project.
+
+Args:
+  parent: string, Required. The project and location to be used to check CSS metadata for target project information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for GetMsComplianceMetadata
+  "projectId": "A String", # Required. The project id of the target project
+}
+
+  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 GetMsComplianceMetadata
+  "isAssuredWorkload": True or False, # The ms compliance metadata of the target project, if the project is an Assured Workloads project, values will be true, otherwise false.
+}
+
+ +
+ 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",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1beta.projects.locations.operations.html b/docs/dyn/backupdr_v1beta.projects.locations.operations.html new file mode 100644 index 0000000000..e564e51f71 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.locations.operations.html @@ -0,0 +1,239 @@ + + + +

Backup and DR Service API . projects . locations . operations

+

Instance Methods

+

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

+

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

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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

+

+ get(name, x__xgafv=None)

+

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

+

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

+

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

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

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

Backup and DR Service API . projects . locations . resourceBackupConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Fetches ResourceBackupConfigs.

+

+ fetch_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Lists ResourceBackupConfigs.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ fetch(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Fetches ResourceBackupConfigs.
+
+Args:
+  parent: string, Required. The project, folder or organization and location for which to retrieve resource backup configs. Format: 'projects/{project_id}/locations/{location}', 'folders/{folder_id}/locations/{location}', or 'organizations/{organization_id}/locations/{location}'. (required)
+  filter: string, Optional. Filtering results.
+  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 use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500.
+  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 for FetchResourceBackupConfigs.
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "resourceBackupConfigs": [ # The list of ResourceBackupConfigs for the specified scope.
+    { # ResourceBackupConfig represents a resource along with its backup configurations.
+      "backupConfigsDetails": [ # Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.
+        { # BackupConfigDetails has information about how the resource is configured for backups and about the most recent backup taken for this configuration.
+          "applicableResource": "A String", # Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the resource that is applicable for the backup configuration. Example: "//compute.googleapis.com/projects/{project}/zones/{zone}/instances/{instance}"
+          "backupConfigSource": "A String", # Output only. The full resource name of the backup config source resource. For example, "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupPlans/{backupplanId}" or "//compute.googleapis.com/projects/{project}/locations/{region}/resourcePolicies/{resourcePolicyId}".
+          "backupConfigSourceDisplayName": "A String", # Output only. The display name of the backup config source resource.
+          "backupDrPlanConfig": { # BackupDrPlanConfig has additional information about Google Cloud Backup and DR's Plan backup configuration. # Google Cloud Backup and DR's Backup Plan specific data.
+            "backupDrPlanRules": [ # Backup rules of the backup plan resource.
+              { # BackupDrPlanRule has rule specific information of the backup plan resource.
+                "lastSuccessfulBackupTime": "A String", # Output only. Timestamp of the latest successful backup created via this backup rule.
+                "ruleId": "A String", # Output only. Unique Id of the backup rule.
+              },
+            ],
+          },
+          "backupDrTemplateConfig": { # Provides additional information about Google Cloud Backup and DR's Template backup configuration. # Google Cloud Backup and DR's Template specific data.
+            "firstPartyManagementUri": "A String", # Output only. The URI of the BackupDr template resource for the first party identity users.
+            "thirdPartyManagementUri": "A String", # Output only. The URI of the BackupDr template resource for the third party identity users.
+          },
+          "backupLocations": [ # The locations where the backups are to be stored.
+            { # BackupLocation represents a cloud location where a backup can be stored.
+              "locationId": "A String", # Output only. The id of the cloud location. Example: "us-central1"
+              "type": "A String", # Output only. The type of the location.
+            },
+          ],
+          "backupVault": "A String", # Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the backup vault that will store the backups generated through this backup configuration. Example: "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupVaults/{backupvaultId}"
+          "latestSuccessfulBackupTime": "A String", # Output only. Timestamp of the latest successful backup created via this backup configuration.
+          "pitrSettings": { # Point in time recovery settings of the backup configuration resource. # Output only. Point in time recovery settings of the backup configuration resource.
+            "retentionDays": 42, # Output only. Number of days to retain the backup.
+          },
+          "state": "A String", # Output only. The state of the backup config resource.
+          "type": "A String", # Output only. The type of the backup config resource.
+        },
+      ],
+      "backupConfigured": True or False, # Output only. Whether the target resource is configured for backup. This is true if the backup_configs_details is not empty.
+      "name": "A String", # Identifier. The resource name of the ResourceBackupConfig. Format: projects/{project}/locations/{location}/resourceBackupConfigs/{uid}
+      "targetResource": "A String", # Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the cloud resource that this configuration applies to. Supported resource types are ResourceBackupConfig.ResourceType.
+      "targetResourceDisplayName": "A String", # Output only. The human friendly name of the target resource.
+      "targetResourceLabels": { # Labels associated with the target resource.
+        "a_key": "A String",
+      },
+      "targetResourceType": "A String", # Output only. The type of the target resource.
+      "uid": "A String", # Output only. The unique identifier of the resource backup config.
+      "vaulted": True or False, # Output only. Whether the target resource is protected by a backup vault. This is true if the backup_configs_details is not empty and any of the ResourceBackupConfig.backup_configs_details has a backup configuration with BackupConfigDetails.backup_vault set.
+    },
+  ],
+}
+
+ +
+ fetch_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists ResourceBackupConfigs.
+
+Args:
+  parent: string, Required. The project and location for which to retrieve resource backup configs. Format: 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. (required)
+  filter: string, Optional. Filtering results.
+  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 use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500.
+  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 for ListResourceBackupConfigs.
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "resourceBackupConfigs": [ # The list of ResourceBackupConfigs for the specified scope.
+    { # ResourceBackupConfig represents a resource along with its backup configurations.
+      "backupConfigsDetails": [ # Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.
+        { # BackupConfigDetails has information about how the resource is configured for backups and about the most recent backup taken for this configuration.
+          "applicableResource": "A String", # Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the resource that is applicable for the backup configuration. Example: "//compute.googleapis.com/projects/{project}/zones/{zone}/instances/{instance}"
+          "backupConfigSource": "A String", # Output only. The full resource name of the backup config source resource. For example, "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupPlans/{backupplanId}" or "//compute.googleapis.com/projects/{project}/locations/{region}/resourcePolicies/{resourcePolicyId}".
+          "backupConfigSourceDisplayName": "A String", # Output only. The display name of the backup config source resource.
+          "backupDrPlanConfig": { # BackupDrPlanConfig has additional information about Google Cloud Backup and DR's Plan backup configuration. # Google Cloud Backup and DR's Backup Plan specific data.
+            "backupDrPlanRules": [ # Backup rules of the backup plan resource.
+              { # BackupDrPlanRule has rule specific information of the backup plan resource.
+                "lastSuccessfulBackupTime": "A String", # Output only. Timestamp of the latest successful backup created via this backup rule.
+                "ruleId": "A String", # Output only. Unique Id of the backup rule.
+              },
+            ],
+          },
+          "backupDrTemplateConfig": { # Provides additional information about Google Cloud Backup and DR's Template backup configuration. # Google Cloud Backup and DR's Template specific data.
+            "firstPartyManagementUri": "A String", # Output only. The URI of the BackupDr template resource for the first party identity users.
+            "thirdPartyManagementUri": "A String", # Output only. The URI of the BackupDr template resource for the third party identity users.
+          },
+          "backupLocations": [ # The locations where the backups are to be stored.
+            { # BackupLocation represents a cloud location where a backup can be stored.
+              "locationId": "A String", # Output only. The id of the cloud location. Example: "us-central1"
+              "type": "A String", # Output only. The type of the location.
+            },
+          ],
+          "backupVault": "A String", # Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the backup vault that will store the backups generated through this backup configuration. Example: "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupVaults/{backupvaultId}"
+          "latestSuccessfulBackupTime": "A String", # Output only. Timestamp of the latest successful backup created via this backup configuration.
+          "pitrSettings": { # Point in time recovery settings of the backup configuration resource. # Output only. Point in time recovery settings of the backup configuration resource.
+            "retentionDays": 42, # Output only. Number of days to retain the backup.
+          },
+          "state": "A String", # Output only. The state of the backup config resource.
+          "type": "A String", # Output only. The type of the backup config resource.
+        },
+      ],
+      "backupConfigured": True or False, # Output only. Whether the target resource is configured for backup. This is true if the backup_configs_details is not empty.
+      "name": "A String", # Identifier. The resource name of the ResourceBackupConfig. Format: projects/{project}/locations/{location}/resourceBackupConfigs/{uid}
+      "targetResource": "A String", # Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the cloud resource that this configuration applies to. Supported resource types are ResourceBackupConfig.ResourceType.
+      "targetResourceDisplayName": "A String", # Output only. The human friendly name of the target resource.
+      "targetResourceLabels": { # Labels associated with the target resource.
+        "a_key": "A String",
+      },
+      "targetResourceType": "A String", # Output only. The type of the target resource.
+      "uid": "A String", # Output only. The unique identifier of the resource backup config.
+      "vaulted": True or False, # Output only. Whether the target resource is protected by a backup vault. This is true if the backup_configs_details is not empty and any of the ResourceBackupConfig.backup_configs_details has a backup configuration with BackupConfigDetails.backup_vault set.
+    },
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1beta.projects.locations.serviceConfig.html b/docs/dyn/backupdr_v1beta.projects.locations.serviceConfig.html new file mode 100644 index 0000000000..510f8fee5c --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.locations.serviceConfig.html @@ -0,0 +1,137 @@ + + + +

Backup and DR Service API . projects . locations . serviceConfig

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Initializes the service related config for a project.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ initialize(name, body=None, x__xgafv=None) +
Initializes the service related config for a project.
+
+Args:
+  name: string, Required. The resource name of the serviceConfig used to initialize the service. The location must be the location of the BackupVault. Format: `projects/{project_id}/locations/{location}/serviceConfig`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for initializing the service.
+  "backupPlanLocation": "A String", # Optional. The location where the BackupPlan will be created. This field is required for multi-region BackupVaults and is optional for regional BackupVaults. It is useful when creating a Backup Vault in a multi-region, allowing the BackupPlan to reside in a specific region within that multi-region. If this field is not provided, the BackupPlan will be created in the same location as specified in the `name` field.
+  "cloudSqlInstanceInitializationConfig": { # CloudSqlInstanceInitializationConfig contains the configuration for initializing a Cloud SQL instance. # Optional. The configuration for initializing a Cloud SQL instance.
+    "edition": "A String", # Required. The edition of the Cloud SQL instance.
+  },
+  "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 since the first request. For example, consider a situation where you make an initial request and t he 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).
+  "resourceType": "A String", # Required. The resource type to which the default service config will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket".
+  "validateOnly": True or False, # Optional. If set, validates the request and returns the result, but does not actually run it.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1beta.projects.locations.trial.html b/docs/dyn/backupdr_v1beta.projects.locations.trial.html new file mode 100644 index 0000000000..b9038b2719 --- /dev/null +++ b/docs/dyn/backupdr_v1beta.projects.locations.trial.html @@ -0,0 +1,151 @@ + + + +

Backup and DR Service API . projects . locations . trial

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Ends the trial for a project

+

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

+

Subscribes to a trial for a project

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ end(parent, body=None, x__xgafv=None) +
Ends the trial for a project
+
+Args:
+  parent: string, Required. The parent resource where the trial has been created. Format: projects/{project}/locations/{location} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ending a trial.
+  "endReason": "A String", # Required. The reason for ending the trial.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Trial for a project.
+  "endReason": "A String", # Output only. The reason for ending the trial.
+  "endTime": "A String", # Output only. The time when the trial will expire.
+  "name": "A String", # Identifier. The resource name of the trial. Format: projects/{project}/locations/{location}/trial
+  "startTime": "A String", # Output only. The time when the trial was subscribed.
+  "state": "A String", # Output only. The state of the trial.
+}
+
+ +
+ subscribe(parent, body=None, x__xgafv=None) +
Subscribes to a trial for a project
+
+Args:
+  parent: string, Required. The project where this trial will be created. Format: projects/{project}/locations/{location} Supported Locations are - us, eu and asia. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for subscribing to a trial.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Trial for a project.
+  "endReason": "A String", # Output only. The reason for ending the trial.
+  "endTime": "A String", # Output only. The time when the trial will expire.
+  "name": "A String", # Identifier. The resource name of the trial. Format: projects/{project}/locations/{location}/trial
+  "startTime": "A String", # Output only. The time when the trial was subscribed.
+  "state": "A String", # Output only. The state of the trial.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/docs_v1.documents.html b/docs/dyn/docs_v1.documents.html index 6825d53428..03fd54c4f7 100644 --- a/docs/dyn/docs_v1.documents.html +++ b/docs/dyn/docs_v1.documents.html @@ -10826,7 +10826,7 @@

Method Details

}, }, "suggestionsViewMode": "A String", # Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. - "tabs": [ # Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field. + "tabs": [ # Output only. Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field. { # A tab in a document. "childTabs": [ # The child tabs nested within this tab. # Object with schema name: Tab @@ -30078,7 +30078,7 @@

Method Details

}, }, "suggestionsViewMode": "A String", # Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. - "tabs": [ # Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field. + "tabs": [ # Output only. Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field. { # A tab in a document. "childTabs": [ # The child tabs nested within this tab. # Object with schema name: Tab @@ -49344,7 +49344,7 @@

Method Details

}, }, "suggestionsViewMode": "A String", # Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. - "tabs": [ # Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field. + "tabs": [ # Output only. Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field. { # A tab in a document. "childTabs": [ # The child tabs nested within this tab. # Object with schema name: Tab diff --git a/docs/dyn/gkehub_v1.projects.locations.rollouts.html b/docs/dyn/gkehub_v1.projects.locations.rollouts.html index 27e93d7d43..50dfbebce8 100644 --- a/docs/dyn/gkehub_v1.projects.locations.rollouts.html +++ b/docs/dyn/gkehub_v1.projects.locations.rollouts.html @@ -240,7 +240,7 @@

Method Details

Returns: An object of the form: - { # Rollout contains the Rollout metadata and configuration. Next ID: 31 + { # Rollout contains the Rollout metadata and configuration. Next ID: 32 "completeTime": "A String", # Output only. The timestamp at which the Rollout was completed. "createTime": "A String", # Output only. The timestamp at which the Rollout was created. "deleteTime": "A String", # Output only. The timestamp at the Rollout was deleted. @@ -320,7 +320,7 @@

Method Details

{ # Response message for listing rollouts. "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. "rollouts": [ # The rollouts from the specified parent resource. - { # Rollout contains the Rollout metadata and configuration. Next ID: 31 + { # Rollout contains the Rollout metadata and configuration. Next ID: 32 "completeTime": "A String", # Output only. The timestamp at which the Rollout was completed. "createTime": "A String", # Output only. The timestamp at which the Rollout was created. "deleteTime": "A String", # Output only. The timestamp at the Rollout was deleted. diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.rollouts.html b/docs/dyn/gkehub_v1alpha.projects.locations.rollouts.html index 5424f7389b..38ed9d5ec7 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.rollouts.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.rollouts.html @@ -240,7 +240,7 @@

Method Details

Returns: An object of the form: - { # Rollout contains the Rollout metadata and configuration. Next ID: 31 + { # Rollout contains the Rollout metadata and configuration. Next ID: 32 "completeTime": "A String", # Output only. The timestamp at which the Rollout was completed. "createTime": "A String", # Output only. The timestamp at which the Rollout was created. "deleteTime": "A String", # Output only. The timestamp at the Rollout was deleted. @@ -320,7 +320,7 @@

Method Details

{ # Response message for listing rollouts. "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. "rollouts": [ # The rollouts from the specified parent resource. - { # Rollout contains the Rollout metadata and configuration. Next ID: 31 + { # Rollout contains the Rollout metadata and configuration. Next ID: 32 "completeTime": "A String", # Output only. The timestamp at which the Rollout was completed. "createTime": "A String", # Output only. The timestamp at which the Rollout was created. "deleteTime": "A String", # Output only. The timestamp at the Rollout was deleted. diff --git a/docs/dyn/gkehub_v1beta.projects.locations.rollouts.html b/docs/dyn/gkehub_v1beta.projects.locations.rollouts.html index ab1f38d5dc..2342d4e554 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.rollouts.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.rollouts.html @@ -240,7 +240,7 @@

Method Details

Returns: An object of the form: - { # Rollout contains the Rollout metadata and configuration. Next ID: 31 + { # Rollout contains the Rollout metadata and configuration. Next ID: 32 "completeTime": "A String", # Output only. The timestamp at which the Rollout was completed. "createTime": "A String", # Output only. The timestamp at which the Rollout was created. "deleteTime": "A String", # Output only. The timestamp at the Rollout was deleted. @@ -320,7 +320,7 @@

Method Details

{ # Response message for listing rollouts. "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. "rollouts": [ # The rollouts from the specified parent resource. - { # Rollout contains the Rollout metadata and configuration. Next ID: 31 + { # Rollout contains the Rollout metadata and configuration. Next ID: 32 "completeTime": "A String", # Output only. The timestamp at which the Rollout was completed. "createTime": "A String", # Output only. The timestamp at which the Rollout was created. "deleteTime": "A String", # Output only. The timestamp at the Rollout was deleted. diff --git a/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html b/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html index 2de8b00b78..a776613831 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html +++ b/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html @@ -239,7 +239,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -304,7 +304,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -458,7 +458,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -523,7 +523,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -777,7 +777,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -842,7 +842,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -996,7 +996,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -1061,7 +1061,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -1303,7 +1303,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -1368,7 +1368,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -1522,7 +1522,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -1587,7 +1587,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -1790,7 +1790,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -1855,7 +1855,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -2009,7 +2009,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -2074,7 +2074,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html b/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html index 61c486b0fb..505ec14eff 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html @@ -239,7 +239,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -304,7 +304,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -458,7 +458,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -523,7 +523,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -777,7 +777,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -842,7 +842,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -996,7 +996,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -1061,7 +1061,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -1303,7 +1303,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -1368,7 +1368,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -1522,7 +1522,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -1587,7 +1587,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -1790,7 +1790,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -1855,7 +1855,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -2009,7 +2009,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. @@ -2074,7 +2074,7 @@

Method Details

}, ], "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. - "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. { # Describes a set of MCP methods to match against. "name": "A String", # Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. diff --git a/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html b/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html index d3bddccfdf..b0352f93d5 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html @@ -1100,7 +1100,7 @@

Method Details

} requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Exadata resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Exadata resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the service treats this as an implied field mask equivalent to all fields that are populated (have a non-empty value). To clear or unset a field, the field must be explicitly specified in the `update_mask`. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.html b/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.html index 4c2d682954..25ec63e7f9 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.html @@ -451,7 +451,7 @@

Method Details

} requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - updateMask: string, Optional. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then all the fields in the VM Cluster are overwritten. + updateMask: string, Optional. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then the service treats this as an implied field mask equivalent to all fields that are populated (have a non-empty value). To clear or unset a field, the field must be explicitly specified in the `update_mask`. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/storage_v1.objects.html b/docs/dyn/storage_v1.objects.html index 1173965f86..34b7f505fb 100644 --- a/docs/dyn/storage_v1.objects.html +++ b/docs/dyn/storage_v1.objects.html @@ -237,6 +237,7 @@

Method Details

"custom": { # User-defined object contexts. "a_key": { # The payload of a single user-defined object context. # A single user-defined object context. "createTime": "A String", # The time at which the object context was created in RFC 3339 format. + "extendedDataTypeUrl": "A String", # The type URL of the object context's extended data. "updateTime": "A String", # The time at which the object context was last updated in RFC 3339 format. "value": "A String", # The value of the object context. }, @@ -358,6 +359,7 @@

Method Details

"custom": { # User-defined object contexts. "a_key": { # The payload of a single user-defined object context. # A single user-defined object context. "createTime": "A String", # The time at which the object context was created in RFC 3339 format. + "extendedDataTypeUrl": "A String", # The type URL of the object context's extended data. "updateTime": "A String", # The time at which the object context was last updated in RFC 3339 format. "value": "A String", # The value of the object context. }, @@ -461,6 +463,7 @@

Method Details

"custom": { # User-defined object contexts. "a_key": { # The payload of a single user-defined object context. # A single user-defined object context. "createTime": "A String", # The time at which the object context was created in RFC 3339 format. + "extendedDataTypeUrl": "A String", # The type URL of the object context's extended data. "updateTime": "A String", # The time at which the object context was last updated in RFC 3339 format. "value": "A String", # The value of the object context. }, @@ -578,6 +581,7 @@

Method Details

"custom": { # User-defined object contexts. "a_key": { # The payload of a single user-defined object context. # A single user-defined object context. "createTime": "A String", # The time at which the object context was created in RFC 3339 format. + "extendedDataTypeUrl": "A String", # The type URL of the object context's extended data. "updateTime": "A String", # The time at which the object context was last updated in RFC 3339 format. "value": "A String", # The value of the object context. }, @@ -708,6 +712,7 @@

Method Details

"custom": { # User-defined object contexts. "a_key": { # The payload of a single user-defined object context. # A single user-defined object context. "createTime": "A String", # The time at which the object context was created in RFC 3339 format. + "extendedDataTypeUrl": "A String", # The type URL of the object context's extended data. "updateTime": "A String", # The time at which the object context was last updated in RFC 3339 format. "value": "A String", # The value of the object context. }, @@ -888,6 +893,7 @@

Method Details

"custom": { # User-defined object contexts. "a_key": { # The payload of a single user-defined object context. # A single user-defined object context. "createTime": "A String", # The time at which the object context was created in RFC 3339 format. + "extendedDataTypeUrl": "A String", # The type URL of the object context's extended data. "updateTime": "A String", # The time at which the object context was last updated in RFC 3339 format. "value": "A String", # The value of the object context. }, @@ -1004,6 +1010,7 @@

Method Details

"custom": { # User-defined object contexts. "a_key": { # The payload of a single user-defined object context. # A single user-defined object context. "createTime": "A String", # The time at which the object context was created in RFC 3339 format. + "extendedDataTypeUrl": "A String", # The type URL of the object context's extended data. "updateTime": "A String", # The time at which the object context was last updated in RFC 3339 format. "value": "A String", # The value of the object context. }, @@ -1124,6 +1131,7 @@

Method Details

"custom": { # User-defined object contexts. "a_key": { # The payload of a single user-defined object context. # A single user-defined object context. "createTime": "A String", # The time at which the object context was created in RFC 3339 format. + "extendedDataTypeUrl": "A String", # The type URL of the object context's extended data. "updateTime": "A String", # The time at which the object context was last updated in RFC 3339 format. "value": "A String", # The value of the object context. }, @@ -1261,6 +1269,7 @@

Method Details

"custom": { # User-defined object contexts. "a_key": { # The payload of a single user-defined object context. # A single user-defined object context. "createTime": "A String", # The time at which the object context was created in RFC 3339 format. + "extendedDataTypeUrl": "A String", # The type URL of the object context's extended data. "updateTime": "A String", # The time at which the object context was last updated in RFC 3339 format. "value": "A String", # The value of the object context. }, @@ -1362,6 +1371,7 @@

Method Details

"custom": { # User-defined object contexts. "a_key": { # The payload of a single user-defined object context. # A single user-defined object context. "createTime": "A String", # The time at which the object context was created in RFC 3339 format. + "extendedDataTypeUrl": "A String", # The type URL of the object context's extended data. "updateTime": "A String", # The time at which the object context was last updated in RFC 3339 format. "value": "A String", # The value of the object context. }, @@ -1475,6 +1485,7 @@

Method Details

"custom": { # User-defined object contexts. "a_key": { # The payload of a single user-defined object context. # A single user-defined object context. "createTime": "A String", # The time at which the object context was created in RFC 3339 format. + "extendedDataTypeUrl": "A String", # The type URL of the object context's extended data. "updateTime": "A String", # The time at which the object context was last updated in RFC 3339 format. "value": "A String", # The value of the object context. }, @@ -1589,6 +1600,7 @@

Method Details

"custom": { # User-defined object contexts. "a_key": { # The payload of a single user-defined object context. # A single user-defined object context. "createTime": "A String", # The time at which the object context was created in RFC 3339 format. + "extendedDataTypeUrl": "A String", # The type URL of the object context's extended data. "updateTime": "A String", # The time at which the object context was last updated in RFC 3339 format. "value": "A String", # The value of the object context. }, @@ -1692,6 +1704,7 @@

Method Details

"custom": { # User-defined object contexts. "a_key": { # The payload of a single user-defined object context. # A single user-defined object context. "createTime": "A String", # The time at which the object context was created in RFC 3339 format. + "extendedDataTypeUrl": "A String", # The type URL of the object context's extended data. "updateTime": "A String", # The time at which the object context was last updated in RFC 3339 format. "value": "A String", # The value of the object context. }, @@ -1819,6 +1832,7 @@

Method Details

"custom": { # User-defined object contexts. "a_key": { # The payload of a single user-defined object context. # A single user-defined object context. "createTime": "A String", # The time at which the object context was created in RFC 3339 format. + "extendedDataTypeUrl": "A String", # The type URL of the object context's extended data. "updateTime": "A String", # The time at which the object context was last updated in RFC 3339 format. "value": "A String", # The value of the object context. }, @@ -2062,6 +2076,7 @@

Method Details

"custom": { # User-defined object contexts. "a_key": { # The payload of a single user-defined object context. # A single user-defined object context. "createTime": "A String", # The time at which the object context was created in RFC 3339 format. + "extendedDataTypeUrl": "A String", # The type URL of the object context's extended data. "updateTime": "A String", # The time at which the object context was last updated in RFC 3339 format. "value": "A String", # The value of the object context. }, @@ -2175,6 +2190,7 @@

Method Details

"custom": { # User-defined object contexts. "a_key": { # The payload of a single user-defined object context. # A single user-defined object context. "createTime": "A String", # The time at which the object context was created in RFC 3339 format. + "extendedDataTypeUrl": "A String", # The type URL of the object context's extended data. "updateTime": "A String", # The time at which the object context was last updated in RFC 3339 format. "value": "A String", # The value of the object context. }, diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index cad219e5c3..9be26dfcea 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -4357,7 +4357,7 @@ ] }, "get": { -"description": "Retrieve a single Key Event.", +"description": "Retrieves a single Key Event.", "flatPath": "v1alpha/properties/{propertiesId}/keyEvents/{keyEventsId}", "httpMethod": "GET", "id": "analyticsadmin.properties.keyEvents.get", @@ -5146,7 +5146,7 @@ } } }, -"revision": "20260802", +"revision": "20260908", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json index 84351d5716..307f42c175 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json @@ -1687,7 +1687,7 @@ ] }, "get": { -"description": "Retrieve a single Key Event.", +"description": "Retrieves a single Key Event.", "flatPath": "v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}", "httpMethod": "GET", "id": "analyticsadmin.properties.keyEvents.get", @@ -1788,7 +1788,7 @@ } } }, -"revision": "20260802", +"revision": "20260908", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1betaAccessBetweenFilter": { diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index d7e36fa672..3a64ba1115 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -5970,7 +5970,7 @@ } } }, -"revision": "20260901", +"revision": "20260909", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -6488,7 +6488,7 @@ "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.", +"description": "An installable set of active APKs. All APKs in this set should belong to the same version of the app. 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": { @@ -14575,7 +14575,7 @@ false, false, false, false, -false, +true, false, false, false, @@ -14598,7 +14598,7 @@ false "Manage store presence.", "Create, edit, and delete draft apps.", "Create and publish private apps to your organization.", -"Choose whether apps are public, or only available to your organization.", +"Deprecated: This permission is no longer supported. Choose whether apps are public, or only available to your organization.", "Manage orders and subscriptions.", "Manage policy related pages on all apps for the developer.", "View app information and download bulk reports (read-only).", diff --git a/googleapiclient/discovery_cache/documents/auditmanager.v1.json b/googleapiclient/discovery_cache/documents/auditmanager.v1.json new file mode 100644 index 0000000000..eee1dfbb22 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/auditmanager.v1.json @@ -0,0 +1,2225 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/cloud-auditmanager": { +"description": "See, edit, configure, and delete your Google Cloud Auditmanager data and see the email address for your Google Account" +}, +"https://www.googleapis.com/auth/cloud-platform": { +"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +} +} +} +}, +"basePath": "", +"baseUrl": "https://auditmanager.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Cloud Audit Manager", +"description": "The Audit Manager API allows customers to manage compliance audits.", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/assured-workloads/docs/audit-manager", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://auditmanager.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://auditmanager.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://auditmanager.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +} +], +"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": "auditmanager:v1", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://auditmanager.mtls.googleapis.com/", +"name": "auditmanager", +"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": { +"folders": { +"resources": { +"locations": { +"methods": { +"enrollResource": { +"description": "Adds your project, folder, or organization to Audit Manager. This method creates the Audit Manager service agent in your workload and grants required permissions to the service agent. If you make this request on a workload that's already enrolled, then this method overrides the existing set of destinations.", +"flatPath": "v1/folders/{foldersId}/locations/{locationsId}:enrollResource", +"httpMethod": "POST", +"id": "auditmanager.folders.locations.enrollResource", +"parameterOrder": [ +"scope" +], +"parameters": { +"scope": { +"description": "Required. Organization, folder, or project to enroll in Audit Manager, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`", +"location": "path", +"pattern": "^folders/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+scope}:enrollResource", +"request": { +"$ref": "EnrollResourceRequest" +}, +"response": { +"$ref": "Enrollment" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"auditReports": { +"methods": { +"generate": { +"description": "Registers audit report generation requests. This method returns the operation identifier that you can use to track the report generation progress.", +"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/auditReports:generate", +"httpMethod": "POST", +"id": "auditmanager.folders.locations.auditReports.generate", +"parameterOrder": [ +"scope" +], +"parameters": { +"scope": { +"description": "Required. Organization, folder, or project that the audit applies to, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`", +"location": "path", +"pattern": "^folders/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+scope}/auditReports:generate", +"request": { +"$ref": "GenerateAuditReportRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the full metadata and findings for an audit report.", +"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/auditReports/{auditReportsId}", +"httpMethod": "GET", +"id": "auditmanager.folders.locations.auditReports.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the audit report, in one of the following formats: * `projects/{project}/locations/{location}/auditReports/{audit_report}` * `folders/{folder}/locations/{location}/auditReports/{audit_report}` * `organizations/{organization}/locations/{location}/auditReports/{audit_report}`", +"location": "path", +"pattern": "^folders/[^/]+/locations/[^/]+/auditReports/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "AuditReport" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists the audit reports for the organization, folder, or project that you specify as the parent scope.", +"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/auditReports", +"httpMethod": "GET", +"id": "auditmanager.folders.locations.auditReports.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous call, to retrieve the next page of results.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent organization, folder, or project to list reports for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`", +"location": "path", +"pattern": "^folders/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/auditReports", +"response": { +"$ref": "ListAuditReportsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"auditScopeReports": { +"methods": { +"generate": { +"description": "Generates an audit scope report for the given standard. The report includes the following: * The technical attributes and constraints that Audit Manager uses to verify your compliance with a framework. * A list of Google Cloud services and resources that are within the scope of the framework.", +"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/auditScopeReports:generate", +"httpMethod": "POST", +"id": "auditmanager.folders.locations.auditScopeReports.generate", +"parameterOrder": [ +"scope" +], +"parameters": { +"scope": { +"description": "Required. Project or folder that the audit scope report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`", +"location": "path", +"pattern": "^folders/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+scope}/auditScopeReports:generate", +"request": { +"$ref": "GenerateAuditScopeReportRequest" +}, +"response": { +"$ref": "AuditScopeReport" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"operationDetails": { +"methods": { +"get": { +"description": "Gets details about the long-running operation to generate audit reports.", +"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/operationDetails/{operationDetailsId}", +"httpMethod": "GET", +"id": "auditmanager.folders.locations.operationDetails.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^folders/[^/]+/locations/[^/]+/operationDetails/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"operationIds": { +"methods": { +"get": { +"description": "Gets details about the long-running operation to generate audit reports.", +"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/operationIds/{operationIdsId}", +"httpMethod": "GET", +"id": "auditmanager.folders.locations.operationIds.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^folders/[^/]+/locations/[^/]+/operationIds/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"resourceEnrollmentStatuses": { +"methods": { +"get": { +"description": "Gets a resource and its enrollment status.", +"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/resourceEnrollmentStatuses/{resourceEnrollmentStatusesId}", +"httpMethod": "GET", +"id": "auditmanager.folders.locations.resourceEnrollmentStatuses.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource enrollment status, in one of the following formats: * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`", +"location": "path", +"pattern": "^folders/[^/]+/locations/[^/]+/resourceEnrollmentStatuses/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "ResourceEnrollmentStatus" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all the folders and projects in an organization or folder, along with their enrollments.", +"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/resourceEnrollmentStatuses", +"httpMethod": "GET", +"id": "auditmanager.folders.locations.resourceEnrollmentStatuses.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous call, to retrieve the next page of results.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent organization or folder to list enrollment statuses for, in one of the following formats: * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`", +"location": "path", +"pattern": "^folders/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/resourceEnrollmentStatuses", +"response": { +"$ref": "ListResourceEnrollmentStatusesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"standards": { +"resources": { +"controls": { +"methods": { +"list": { +"description": "Lists the controls that you must implement to become compliant to a regulatory standard.", +"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/standards/{standardsId}/controls", +"httpMethod": "GET", +"id": "auditmanager.folders.locations.standards.controls.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous call, to retrieve the next page of results.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Standard to list controls for, in one of the following formats: * `projects/{project}/locations/{location}/standards/{standard}` * `folders/{folder}/locations/{location}/standards/{standard}` * `organizations/{organization}/locations/{location}/standards/{standard}`", +"location": "path", +"pattern": "^folders/[^/]+/locations/[^/]+/standards/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/controls", +"response": { +"$ref": "ListControlsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +}, +"organizations": { +"resources": { +"locations": { +"methods": { +"enrollResource": { +"description": "Adds your project, folder, or organization to Audit Manager. This method creates the Audit Manager service agent in your workload and grants required permissions to the service agent. If you make this request on a workload that's already enrolled, then this method overrides the existing set of destinations.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}:enrollResource", +"httpMethod": "POST", +"id": "auditmanager.organizations.locations.enrollResource", +"parameterOrder": [ +"scope" +], +"parameters": { +"scope": { +"description": "Required. Organization, folder, or project to enroll in Audit Manager, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+scope}:enrollResource", +"request": { +"$ref": "EnrollResourceRequest" +}, +"response": { +"$ref": "Enrollment" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"auditReports": { +"methods": { +"generate": { +"description": "Registers audit report generation requests. This method returns the operation identifier that you can use to track the report generation progress.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/auditReports:generate", +"httpMethod": "POST", +"id": "auditmanager.organizations.locations.auditReports.generate", +"parameterOrder": [ +"scope" +], +"parameters": { +"scope": { +"description": "Required. Organization, folder, or project that the audit applies to, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+scope}/auditReports:generate", +"request": { +"$ref": "GenerateAuditReportRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the full metadata and findings for an audit report.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/auditReports/{auditReportsId}", +"httpMethod": "GET", +"id": "auditmanager.organizations.locations.auditReports.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the audit report, in one of the following formats: * `projects/{project}/locations/{location}/auditReports/{audit_report}` * `folders/{folder}/locations/{location}/auditReports/{audit_report}` * `organizations/{organization}/locations/{location}/auditReports/{audit_report}`", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/auditReports/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "AuditReport" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists the audit reports for the organization, folder, or project that you specify as the parent scope.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/auditReports", +"httpMethod": "GET", +"id": "auditmanager.organizations.locations.auditReports.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous call, to retrieve the next page of results.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent organization, folder, or project to list reports for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/auditReports", +"response": { +"$ref": "ListAuditReportsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"auditScopeReports": { +"methods": { +"generate": { +"description": "Generates an audit scope report for the given standard. The report includes the following: * The technical attributes and constraints that Audit Manager uses to verify your compliance with a framework. * A list of Google Cloud services and resources that are within the scope of the framework.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/auditScopeReports:generate", +"httpMethod": "POST", +"id": "auditmanager.organizations.locations.auditScopeReports.generate", +"parameterOrder": [ +"scope" +], +"parameters": { +"scope": { +"description": "Required. Project or folder that the audit scope report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+scope}/auditScopeReports:generate", +"request": { +"$ref": "GenerateAuditScopeReportRequest" +}, +"response": { +"$ref": "AuditScopeReport" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"operationDetails": { +"methods": { +"get": { +"description": "Gets details about the long-running operation to generate audit reports.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operationDetails/{operationDetailsId}", +"httpMethod": "GET", +"id": "auditmanager.organizations.locations.operationDetails.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/operationDetails/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"operationIds": { +"methods": { +"get": { +"description": "Gets details about the long-running operation to generate audit reports.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operationIds/{operationIdsId}", +"httpMethod": "GET", +"id": "auditmanager.organizations.locations.operationIds.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/operationIds/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"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/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "auditmanager.organizations.locations.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"request": { +"$ref": "CancelOperationRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"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/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "auditmanager.organizations.locations.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"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/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "auditmanager.organizations.locations.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"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/organizations/{organizationsId}/locations/{locationsId}/operations", +"httpMethod": "GET", +"id": "auditmanager.organizations.locations.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. 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": "ListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"resourceEnrollmentStatuses": { +"methods": { +"get": { +"description": "Gets a resource and its enrollment status.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/resourceEnrollmentStatuses/{resourceEnrollmentStatusesId}", +"httpMethod": "GET", +"id": "auditmanager.organizations.locations.resourceEnrollmentStatuses.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource enrollment status, in one of the following formats: * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/resourceEnrollmentStatuses/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "ResourceEnrollmentStatus" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all the folders and projects in an organization or folder, along with their enrollments.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/resourceEnrollmentStatuses", +"httpMethod": "GET", +"id": "auditmanager.organizations.locations.resourceEnrollmentStatuses.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous call, to retrieve the next page of results.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent organization or folder to list enrollment statuses for, in one of the following formats: * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/resourceEnrollmentStatuses", +"response": { +"$ref": "ListResourceEnrollmentStatusesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"standards": { +"resources": { +"controls": { +"methods": { +"list": { +"description": "Lists the controls that you must implement to become compliant to a regulatory standard.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/standards/{standardsId}/controls", +"httpMethod": "GET", +"id": "auditmanager.organizations.locations.standards.controls.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous call, to retrieve the next page of results.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Standard to list controls for, in one of the following formats: * `projects/{project}/locations/{location}/standards/{standard}` * `folders/{folder}/locations/{location}/standards/{standard}` * `organizations/{organization}/locations/{location}/standards/{standard}`", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/standards/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/controls", +"response": { +"$ref": "ListControlsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +}, +"projects": { +"resources": { +"locations": { +"methods": { +"enrollResource": { +"description": "Adds your project, folder, or organization to Audit Manager. This method creates the Audit Manager service agent in your workload and grants required permissions to the service agent. If you make this request on a workload that's already enrolled, then this method overrides the existing set of destinations.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:enrollResource", +"httpMethod": "POST", +"id": "auditmanager.projects.locations.enrollResource", +"parameterOrder": [ +"scope" +], +"parameters": { +"scope": { +"description": "Required. Organization, folder, or project to enroll in Audit Manager, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+scope}:enrollResource", +"request": { +"$ref": "EnrollResourceRequest" +}, +"response": { +"$ref": "Enrollment" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets information about a location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}", +"httpMethod": "GET", +"id": "auditmanager.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-auditmanager", +"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": "auditmanager.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-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"auditReports": { +"methods": { +"generate": { +"description": "Registers audit report generation requests. This method returns the operation identifier that you can use to track the report generation progress.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/auditReports:generate", +"httpMethod": "POST", +"id": "auditmanager.projects.locations.auditReports.generate", +"parameterOrder": [ +"scope" +], +"parameters": { +"scope": { +"description": "Required. Organization, folder, or project that the audit applies to, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+scope}/auditReports:generate", +"request": { +"$ref": "GenerateAuditReportRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the full metadata and findings for an audit report.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/auditReports/{auditReportsId}", +"httpMethod": "GET", +"id": "auditmanager.projects.locations.auditReports.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the audit report, in one of the following formats: * `projects/{project}/locations/{location}/auditReports/{audit_report}` * `folders/{folder}/locations/{location}/auditReports/{audit_report}` * `organizations/{organization}/locations/{location}/auditReports/{audit_report}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/auditReports/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "AuditReport" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists the audit reports for the organization, folder, or project that you specify as the parent scope.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/auditReports", +"httpMethod": "GET", +"id": "auditmanager.projects.locations.auditReports.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous call, to retrieve the next page of results.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent organization, folder, or project to list reports for, in one of the following 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}/auditReports", +"response": { +"$ref": "ListAuditReportsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"auditScopeReports": { +"methods": { +"generate": { +"description": "Generates an audit scope report for the given standard. The report includes the following: * The technical attributes and constraints that Audit Manager uses to verify your compliance with a framework. * A list of Google Cloud services and resources that are within the scope of the framework.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/auditScopeReports:generate", +"httpMethod": "POST", +"id": "auditmanager.projects.locations.auditScopeReports.generate", +"parameterOrder": [ +"scope" +], +"parameters": { +"scope": { +"description": "Required. Project or folder that the audit scope report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+scope}/auditScopeReports:generate", +"request": { +"$ref": "GenerateAuditScopeReportRequest" +}, +"response": { +"$ref": "AuditScopeReport" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"operationDetails": { +"methods": { +"get": { +"description": "Gets details about the long-running operation to generate audit reports.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operationDetails/{operationDetailsId}", +"httpMethod": "GET", +"id": "auditmanager.projects.locations.operationDetails.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operationDetails/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"operationIds": { +"methods": { +"get": { +"description": "Gets details about the long-running operation to generate audit reports.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operationIds/{operationIdsId}", +"httpMethod": "GET", +"id": "auditmanager.projects.locations.operationIds.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operationIds/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"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}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "auditmanager.projects.locations.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"request": { +"$ref": "CancelOperationRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "auditmanager.projects.locations.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "auditmanager.projects.locations.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", +"httpMethod": "GET", +"id": "auditmanager.projects.locations.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. 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": "ListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"resourceEnrollmentStatuses": { +"methods": { +"get": { +"description": "Gets a resource and its enrollment status.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/resourceEnrollmentStatuses/{resourceEnrollmentStatusesId}", +"httpMethod": "GET", +"id": "auditmanager.projects.locations.resourceEnrollmentStatuses.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource enrollment status, in one of the following formats: * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/resourceEnrollmentStatuses/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "ResourceEnrollmentStatus" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"standards": { +"resources": { +"controls": { +"methods": { +"list": { +"description": "Lists the controls that you must implement to become compliant to a regulatory standard.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/standards/{standardsId}/controls", +"httpMethod": "GET", +"id": "auditmanager.projects.locations.standards.controls.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous call, to retrieve the next page of results.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Standard to list controls for, in one of the following formats: * `projects/{project}/locations/{location}/standards/{standard}` * `folders/{folder}/locations/{location}/standards/{standard}` * `organizations/{organization}/locations/{location}/standards/{standard}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/standards/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/controls", +"response": { +"$ref": "ListControlsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-auditmanager", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +} +}, +"revision": "20260907", +"rootUrl": "https://auditmanager.googleapis.com/", +"schemas": { +"AuditReport": { +"description": "An audit report.", +"id": "AuditReport", +"properties": { +"complianceFramework": { +"description": "Output only. Compliance framework to use for the audit report. For example, `CIS_GCP_FOUNDATIONS_V1_2_0`.", +"readOnly": true, +"type": "string" +}, +"complianceStandard": { +"deprecated": true, +"description": "Output only. Deprecated. Compliance standard to be audited against. Use the `compliance_framework` field instead.", +"readOnly": true, +"type": "string" +}, +"controlDetails": { +"description": "Output only. Overall status of the controls.", +"items": { +"$ref": "ControlDetails" +}, +"readOnly": true, +"type": "array" +}, +"createTime": { +"description": "Output only. Creation time of the audit report.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"destinationDetails": { +"$ref": "DestinationDetails", +"description": "Output only. Cloud Storage bucket where the audit report is uploaded to.", +"readOnly": true +}, +"name": { +"description": "Identifier. Name of the audit report, in one of the following formats: * `projects/{project}/locations/{location}/auditReports/{audit_report}` * `folders/{folder}/locations/{location}/auditReports/{audit_report}` * `organizations/{organization}/locations/{location}/auditReports/{audit_report}`", +"type": "string" +}, +"operationId": { +"description": "Output only. Client operation ID for the audit report.", +"readOnly": true, +"type": "string" +}, +"reportGenerationState": { +"description": "Output only. State of audit report generation.", +"enum": [ +"REPORT_GENERATION_STATE_UNSPECIFIED", +"IN_PROGRESS", +"COMPLETED", +"FAILED", +"SUMMARY_UNKNOWN" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The process is in progress. The operation can have any state except for `OPERATION_STATE_DONE` or `OPERATION_STATE_FAILED`.", +"The process is completed. The operation state is `OPERATION_STATE_DONE`.", +"The process has failed. The operation state is `OPERATION_STATE_FAILED`.", +"The process completed, but the report summary's status is unknown. This state isn't used for new reports." +], +"readOnly": true, +"type": "string" +}, +"reportSummary": { +"$ref": "ReportSummary", +"description": "Output only. Report summary that includes information about compliance and violation counts.", +"readOnly": true +}, +"scope": { +"description": "Output only. Organization, folder, or project that the report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`", +"readOnly": true, +"type": "string" +}, +"scopeId": { +"description": "Output only. Project number, folder ID, or organization ID that the audit report was generated for.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AuditScopeReport": { +"description": "Audit scope report.", +"id": "AuditScopeReport", +"properties": { +"name": { +"description": "Identifier. Name for the audit scope report, in one of the following formats: * `projects/{project}/locations/{location}/auditScopeReports/{audit_scope_report}` * `folders/{folder}/locations/{location}/auditScopeReports/{audit_scope_report}` * `organizations/{organization}/locations/{location}/auditScopeReports/{audit_scope_report}`", +"type": "string" +}, +"scopeReportContents": { +"description": "Audit scope report content in byte format.", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, +"CancelOperationRequest": { +"description": "The request message for Operations.CancelOperation.", +"id": "CancelOperationRequest", +"properties": {}, +"type": "object" +}, +"Control": { +"description": "A control.", +"id": "Control", +"properties": { +"controlFamily": { +"$ref": "ControlFamily", +"description": "Output only. Regulatory family of the control.", +"readOnly": true +}, +"customerResponsibilityDescription": { +"description": "Output only. A description of your responsibility for this control.", +"readOnly": true, +"type": "string" +}, +"customerResponsibilityImplementation": { +"description": "Output only. A description of how you can implement your responsibility for this control.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Output only. Description of the control.", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. Display name of the control.", +"readOnly": true, +"type": "string" +}, +"family": { +"description": "Output only. Category that the control belongs to.", +"enum": [ +"FAMILY_UNSPECIFIED", +"AC", +"AT", +"AU", +"CA", +"CM", +"CP", +"IA", +"IR", +"MA", +"MP", +"PE", +"PL", +"PS", +"RA", +"SA", +"SC", +"SI", +"SR" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Access control.", +"Awareness and training.", +"Audit and accountability.", +"Certification, accreditation and security assessments.", +"Configuration management and change control.", +"Contingency planning and disaster recovery.", +"Identification and authentication.", +"Incident response.", +"Maintenance.", +"Media protection.", +"Physical and environmental protection.", +"Security planning.", +"Personnel security.", +"Risk assessment.", +"System services and acquisition.", +"System and communications protection.", +"System and information integrity.", +"Supply chain risk management." +], +"readOnly": true, +"type": "string" +}, +"googleResponsibilityDescription": { +"description": "Output only. A description of Google's responsibility for this control.", +"readOnly": true, +"type": "string" +}, +"googleResponsibilityImplementation": { +"description": "Output only. A description of how Google implements its responsibility for this control.", +"readOnly": true, +"type": "string" +}, +"id": { +"description": "Output only. Control identifier that's used to fetch the findings. The identifier is the same as the control report name.", +"readOnly": true, +"type": "string" +}, +"responsibilityType": { +"description": "Output only. Who is responsible for implementing this control. Set to one of the following values: `GOOGLE`, `CUSTOMER`, or `SHARED`.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ControlDetails": { +"description": "Evaluation details for a control.", +"id": "ControlDetails", +"properties": { +"complianceState": { +"description": "Output only. Overall status of the findings for the control.", +"enum": [ +"COMPLIANCE_STATE_UNSPECIFIED", +"COMPLIANT", +"VIOLATION", +"MANUAL_REVIEW_NEEDED", +"ERROR", +"AUDIT_NOT_SUPPORTED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The resource is compliant.", +"The resource isn't compliant.", +"You must complete a manual review.", +"An error was encountered during the evaluation or evidence gathering process.", +"The resource can't be audited." +], +"readOnly": true, +"type": "string" +}, +"control": { +"$ref": "Control", +"description": "Control that the findings are being reported for." +}, +"controlReportSummary": { +"$ref": "ReportSummary", +"description": "A control report summary that provides a high-level overview of the compliance controls and the assessment status." +} +}, +"type": "object" +}, +"ControlFamily": { +"description": "Regulatory family of the control.", +"id": "ControlFamily", +"properties": { +"displayName": { +"description": "Display name of the regulatory control family.", +"type": "string" +}, +"familyId": { +"description": "ID of the regulatory control family. To find the list of supported control families, use the ListControls method and review the `control_family` field in the response.", +"type": "string" +} +}, +"type": "object" +}, +"DestinationDetails": { +"description": "Cloud Storage bucket where the audit report is uploaded to.", +"id": "DestinationDetails", +"properties": { +"gcsBucketUri": { +"description": "URI for the Cloud Storage bucket, in the format `gs://{bucket_name}`.", +"type": "string" +} +}, +"type": "object" +}, +"EligibleDestination": { +"description": "Details about the bucket where you want to upload the audit report.", +"id": "EligibleDestination", +"properties": { +"eligibleGcsBucket": { +"description": "The location of the Cloud Storage bucket where you want to upload the audit report and evidence during the GenerateAuditReport API call.", +"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" +}, +"EnrollResourceRequest": { +"description": "Request message for EnrollResource.", +"id": "EnrollResourceRequest", +"properties": { +"destinations": { +"description": "Required. Cloud Storage buckets that you can upload your audit reports to during the audit process. When you enroll an organization or folder, you can choose a Cloud Storage bucket from any project in the organization or folder. If you run an audit at the project level using the service agent at the organization or folder level, all the buckets that are associated with the service agent are available.", +"items": { +"$ref": "EligibleDestination" +}, +"type": "array" +}, +"validateOnly": { +"description": "Optional. If `true`, only validates the request and does not enroll the resource. This executes standard request validation (such as schema, IAM, and destination checks) and skips the apply phase. Use this field for the following purposes: * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run dry-run mutations (e.g., `terraform plan`) without creating real resources or incurring costs. * **User Interface Validation**: Enable real-time form and permission validation in custom UIs before submitting requests. * **CI/CD & Automation**: Test your scripts, permissions, and parameters safely without consuming resource quotas.", +"type": "boolean" +} +}, +"type": "object" +}, +"Enrollment": { +"description": "Organization, folder, or project to enroll for audit reports.", +"id": "Enrollment", +"properties": { +"destinationDetails": { +"description": "Output only. Cloud Storage buckets where you want to upload the audit reports.", +"items": { +"$ref": "DestinationDetails" +}, +"readOnly": true, +"type": "array" +}, +"name": { +"description": "Identifier. Name of the enrollment, in one of the following formats: * `projects/{project}/locations/{location}/enrollments/{enrollment}` * `folders/{folder}/locations/{location}/enrollments/{enrollment}` * `organizations/{organization}/locations/{location}/enrollments/{enrollment}`", +"type": "string" +} +}, +"type": "object" +}, +"GenerateAuditReportRequest": { +"description": "Request message for GenerateAuditReport.", +"id": "GenerateAuditReportRequest", +"properties": { +"complianceFramework": { +"description": "Required. The framework that's used for the audit report. For example, `NIST_800_53`.", +"type": "string" +}, +"complianceStandard": { +"deprecated": true, +"description": "Optional. Deprecated. Compliance standard for the audit report. Use the `compliance_framework` field instead.", +"type": "string" +}, +"gcsUri": { +"description": "URL for the Cloud Storage bucket where the report and evidence is uploaded. You must select a bucket that was provided during the enrollment process.", +"type": "string" +}, +"reportFormat": { +"description": "Required. Format for the audit report.", +"enum": [ +"AUDIT_REPORT_FORMAT_UNSPECIFIED", +"AUDIT_REPORT_FORMAT_ODF" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Open Document format." +], +"type": "string" +}, +"validateOnly": { +"description": "Optional. If `true`, only validates the request and does not generate the audit report. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase. Use this field for the following purposes: * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run dry-run mutations (e.g., `terraform plan`) without creating real resources or incurring costs. * **User Interface Validation**: Enable real-time form and permission validation in custom UIs before submitting requests. * **CI/CD & Automation**: Test your scripts, permissions, and parameters safely without triggering expensive Long-Running Operations (LROs) or consuming resource quotas.", +"type": "boolean" +} +}, +"type": "object" +}, +"GenerateAuditScopeReportRequest": { +"description": "Request message for GenerateAuditScopeReport.", +"id": "GenerateAuditScopeReportRequest", +"properties": { +"complianceFramework": { +"description": "Required. Framework (set of controls) that the audit scope report is generated against. For example, `NIST_800_53`.", +"type": "string" +}, +"complianceStandard": { +"deprecated": true, +"description": "Optional. Deprecated. The standard (industry or regulatory requirements) that the audit scope report is run against. Use the `compliance_framework` field instead.", +"type": "string" +}, +"reportFormat": { +"description": "Required. Format for the audit scope report.", +"enum": [ +"AUDIT_SCOPE_REPORT_FORMAT_UNSPECIFIED", +"AUDIT_SCOPE_REPORT_FORMAT_ODF" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Open Document format." +], +"type": "string" +}, +"validateOnly": { +"description": "Optional. If `true`, only validates the request and does not generate the audit scope report. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase. Use this field for the following purposes: * **Infrastructure as Code (IaC)**: Allow tools like Terraform to run dry-run mutations (e.g., `terraform plan`) without creating real resources or incurring costs. * **User Interface Validation**: Enable real-time form and permission validation in custom UIs before submitting requests. * **CI/CD & Automation**: Test your scripts, permissions, and parameters safely without consuming resource quotas.", +"type": "boolean" +} +}, +"type": "object" +}, +"ListAuditReportsResponse": { +"description": "Response message for ListAuditReports.", +"id": "ListAuditReportsResponse", +"properties": { +"auditReports": { +"description": "Output only. Audit reports.", +"items": { +"$ref": "AuditReport" +}, +"readOnly": true, +"type": "array" +}, +"nextPageToken": { +"description": "Output only. A token that you can send as the `page_token` in a subsequent request to retrieve the next page of results. If this field is empty, there are no subsequent pages.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ListControlsResponse": { +"description": "Response message for ListControls.", +"id": "ListControlsResponse", +"properties": { +"controls": { +"description": "Output only. Controls for a given regulatory standard.", +"items": { +"$ref": "Control" +}, +"readOnly": true, +"type": "array" +}, +"nextPageToken": { +"description": "Output only. A token that you can send as the `page_token` in a subsequent request to retrieve the next page of results. If this field is empty, there are no subsequent pages.", +"readOnly": true, +"type": "string" +} +}, +"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" +}, +"ListOperationsResponse": { +"description": "The response message for Operations.ListOperations.", +"id": "ListOperationsResponse", +"properties": { +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +}, +"operations": { +"description": "A list of operations that matches the specified filter in the request.", +"items": { +"$ref": "Operation" +}, +"type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListResourceEnrollmentStatusesResponse": { +"description": "Response message for ListResourceEnrollmentStatuses.", +"id": "ListResourceEnrollmentStatusesResponse", +"properties": { +"nextPageToken": { +"description": "Output only. A token that you can send as the `page_token` in a subsequent request to retrieve the next page of results. If this field is empty, there are no subsequent pages.", +"readOnly": true, +"type": "string" +}, +"resourceEnrollmentStatuses": { +"description": "Resources with their enrollment status.", +"items": { +"$ref": "ResourceEnrollmentStatus" +}, +"type": "array" +} +}, +"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" +}, +"Operation": { +"description": "This resource represents a long-running operation that is the result of a network API call.", +"id": "Operation", +"properties": { +"done": { +"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", +"type": "boolean" +}, +"error": { +"$ref": "Status", +"description": "The error result of the operation in case of failure or cancellation." +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", +"type": "object" +}, +"name": { +"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", +"type": "string" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", +"type": "object" +} +}, +"type": "object" +}, +"OperationMetadata": { +"description": "Metadata for the long-running operation.", +"id": "OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. The API version used to start the operation. For example, `v1`.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. Time that the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. Time that the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Whether you requested that the operation be cancelled. Operations that were cancelled successfully have an Operation.error value with a status code Code.CANCELLED.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. A human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. A server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. The name of the verb that was executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ReportGenerationProgress": { +"description": "Details about the current status of the report-generation process.", +"id": "ReportGenerationProgress", +"properties": { +"auditReport": { +"description": "Output only. Name of the audit report.", +"readOnly": true, +"type": "string" +}, +"destinationGcsBucket": { +"description": "Output only. Cloud Storage bucket where the audit report is uploaded to after the evaluation process is completed.", +"readOnly": true, +"type": "string" +}, +"evaluationPercentComplete": { +"description": "Progress of the evaluation process. The progress is defined in terms of percentage complete.", +"format": "double", +"type": "number" +}, +"failureReason": { +"description": "Output only. Reason for failure during the audit report generation process. This field is set only if the `OperationState` attribute is `OPERATION_STATE_FAILED`.", +"readOnly": true, +"type": "string" +}, +"reportGenerationPercentComplete": { +"description": "Report generation progress, defined in terms of percentage complete. Until evaluation is complete, this value is always `0`.", +"format": "double", +"type": "number" +}, +"reportUploadingPercentComplete": { +"description": "Report uploading progress, defined in terms of percentage complete. Until evaluation and report generation are complete, this value is always `0`.", +"format": "double", +"type": "number" +}, +"state": { +"description": "Output only. Current state of execution for report generation.", +"enum": [ +"OPERATION_STATE_UNSPECIFIED", +"OPERATION_STATE_NOT_STARTED", +"OPERATION_STATE_EVALUATION_IN_PROGRESS", +"OPERATION_STATE_EVALUATION_DONE", +"OPERATION_STATE_EVIDENCE_REPORT_GENERATION_IN_PROGRESS", +"OPERATION_STATE_EVIDENCE_REPORT_GENERATION_DONE", +"OPERATION_STATE_EVIDENCE_UPLOAD_IN_PROGRESS", +"OPERATION_STATE_DONE", +"OPERATION_STATE_FAILED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Audit generation process hasn't started.", +"Evaluation process is in progress.", +"Evaluation process is completed.", +"Report generation process is in progress.", +"Report generation process is completed.", +"The audit report and evidence are being uploaded to your bucket.", +"The audit report and evidence are uploaded to your bucket.", +"Audit report generation process failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ReportSummary": { +"description": "Additional information about the number of checks that were made during an audit operation.", +"id": "ReportSummary", +"properties": { +"compliantCount": { +"description": "Number of compliant checks.", +"format": "int32", +"type": "integer" +}, +"errorCount": { +"description": "Number of checks that can't be performed due to errors.", +"format": "int32", +"type": "integer" +}, +"manualReviewNeededCount": { +"description": "Number of checks that require a manual review.", +"format": "int32", +"type": "integer" +}, +"totalCount": { +"description": "Total number of evaluated checks.", +"format": "int32", +"type": "integer" +}, +"violationCount": { +"description": "Number of checks with violations.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"ResourceEnrollmentStatus": { +"description": "An organization, folder, or project with its enrollment status.", +"id": "ResourceEnrollmentStatus", +"properties": { +"displayName": { +"description": "Output only. Display name for the organization, folder, or project.", +"readOnly": true, +"type": "string" +}, +"enrolled": { +"deprecated": true, +"description": "Output only. Deprecated. Whether the organization, folder, or project is enrolled. Use `enrollment_state` instead.", +"readOnly": true, +"type": "boolean" +}, +"enrollment": { +"$ref": "Enrollment", +"description": "Output only. Enrolled destination details for the organization, folder, or project.", +"readOnly": true +}, +"enrollmentState": { +"description": "Output only. Enrollment state of the organization, folder, or project.", +"enum": [ +"RESOURCE_ENROLLMENT_STATE_UNSPECIFIED", +"NOT_ENROLLED", +"INHERITED", +"ENROLLED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The resource isn't enrolled.", +"The resource isn't enrolled but the parent is enrolled.", +"The resource is enrolled." +], +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. Name of the resource enrollment status, in one of the following formats: * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`", +"type": "string" +} +}, +"type": "object" +}, +"Status": { +"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", +"id": "Status", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Audit Manager API", +"version": "v1", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1beta.json b/googleapiclient/discovery_cache/documents/backupdr.v1beta.json new file mode 100644 index 0000000000..17029b5c91 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/backupdr.v1beta.json @@ -0,0 +1,8329 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/cloud-backupdr": { +"description": "See, edit, configure, and delete your Google Cloud Backup and DR data and see the email address for your Google Account" +}, +"https://www.googleapis.com/auth/cloud-platform": { +"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +} +} +} +}, +"basePath": "", +"baseUrl": "https://backupdr.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Backupdr", +"description": "", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/backup-disaster-recovery", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.us-west8.rep.googleapis.com/", +"location": "us-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.us.rep.googleapis.com/", +"location": "us" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://backupdr.eu.rep.googleapis.com/", +"location": "eu" +} +], +"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": "backupdr:v1beta", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://backupdr.mtls.googleapis.com/", +"name": "backupdr", +"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": { +"folders": { +"resources": { +"locations": { +"resources": { +"resourceBackupConfigs": { +"methods": { +"fetch": { +"description": "Fetches ResourceBackupConfigs.", +"flatPath": "v1beta/folders/{foldersId}/locations/{locationsId}/resourceBackupConfigs:fetch", +"httpMethod": "GET", +"id": "backupdr.folders.locations.resourceBackupConfigs.fetch", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results.", +"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 use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500.", +"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 project, folder or organization and location for which to retrieve resource backup configs. Format: 'projects/{project_id}/locations/{location}', 'folders/{folder_id}/locations/{location}', or 'organizations/{organization_id}/locations/{location}'.", +"location": "path", +"pattern": "^folders/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/resourceBackupConfigs:fetch", +"response": { +"$ref": "FetchResourceBackupConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, +"organizations": { +"resources": { +"locations": { +"resources": { +"resourceBackupConfigs": { +"methods": { +"fetch": { +"description": "Fetches ResourceBackupConfigs.", +"flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/resourceBackupConfigs:fetch", +"httpMethod": "GET", +"id": "backupdr.organizations.locations.resourceBackupConfigs.fetch", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results.", +"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 use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500.", +"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 project, folder or organization and location for which to retrieve resource backup configs. Format: 'projects/{project_id}/locations/{location}', 'folders/{folder_id}/locations/{location}', or 'organizations/{organization_id}/locations/{location}'.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/resourceBackupConfigs:fetch", +"response": { +"$ref": "FetchResourceBackupConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, +"projects": { +"resources": { +"locations": { +"methods": { +"get": { +"description": "Gets information about a location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", +"httpMethod": "GET", +"id": "backupdr.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-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"getTrial": { +"description": "Gets the Trial state for a given project", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/trial", +"httpMethod": "GET", +"id": "backupdr.projects.locations.getTrial", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The project for which trial details need to be retrieved. Format: projects/{project}/locations/{location} Supported Locations are - us, eu and asia.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/trial$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "Trial" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"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": "backupdr.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-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"appliedAutoProtectionPolicies": { +"methods": { +"list": { +"description": "Lists AppliedAutoProtectionPolicies in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/appliedAutoProtectionPolicies", +"httpMethod": "GET", +"id": "backupdr.projects.locations.appliedAutoProtectionPolicies.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter expression that filters resources listed in the response.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. An expression that sorts the results in the response.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of applied policies to return in a single page.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListAppliedAutoProtectionPolicies` call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location for which to retrieve the list of applied policies. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/appliedAutoProtectionPolicies", +"response": { +"$ref": "ListAppliedAutoProtectionPoliciesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"autoProtectionPolicies": { +"methods": { +"create": { +"description": "Creates a new AutoProtectionPolicy in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies", +"httpMethod": "POST", +"id": "backupdr.projects.locations.autoProtectionPolicies.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"autoProtectionPolicyId": { +"description": "Required. The ID to use for the policy. This will become the final component of the policy's resource name.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where this policy will be created. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/autoProtectionPolicies", +"request": { +"$ref": "AutoProtectionPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single AutoProtectionPolicy.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}", +"httpMethod": "DELETE", +"id": "backupdr.projects.locations.autoProtectionPolicies.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "The current etag of the AutoProtectionPolicy. If an etag is provided and does not match the current etag of the connection, the request will be rejected with an ABORTED error.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the policy to delete. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single AutoProtectionPolicy.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}", +"httpMethod": "GET", +"id": "backupdr.projects.locations.autoProtectionPolicies.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the policy to retrieve. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "AutoProtectionPolicy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists AutoProtectionPolicies for a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies", +"httpMethod": "GET", +"id": "backupdr.projects.locations.autoProtectionPolicies.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter expression that filters resources listed in the response. The following fields are filterable:", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. An expression that sorts the results in the response. The following fields are sortable:", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of policies to return in a single page. If unspecified, a server-default value will be used.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListAutoProtectionPolicies` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location for which to retrieve the list of policies. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/autoProtectionPolicies", +"response": { +"$ref": "ListAutoProtectionPoliciesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single AutoProtectionPolicy.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}", +"httpMethod": "PATCH", +"id": "backupdr.projects.locations.autoProtectionPolicies.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the AutoprotectionPolicy. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the AutoProtectionPolicy 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": "v1beta/{+name}", +"request": { +"$ref": "AutoProtectionPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"bindings": { +"methods": { +"create": { +"description": "Creates a new AutoProtectionPolicyBinding in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings", +"httpMethod": "POST", +"id": "backupdr.projects.locations.autoProtectionPolicies.bindings.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"autoProtectionPolicyBindingId": { +"description": "Required. The ID to use for the binding. This will become the final component of the binding's resource name.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where this binding will be created. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/bindings", +"request": { +"$ref": "AutoProtectionPolicyBinding" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Returns the auto protection policy binding read from the CCFE tables.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings/{bindingsId}", +"httpMethod": "GET", +"id": "backupdr.projects.locations.autoProtectionPolicies.bindings.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the binding to retrieve. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+/bindings/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "AutoProtectionPolicyBinding" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"initiateDelete": { +"description": "InitiateDeleteAutoProtectionPolicyBinding initiates delete for AutoProtectionPolicy Binding", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings/{bindingsId}:initiateDelete", +"httpMethod": "POST", +"id": "backupdr.projects.locations.autoProtectionPolicies.bindings.initiateDelete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the binding to delete. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+/bindings/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}:initiateDelete", +"request": { +"$ref": "InitiateDeleteAutoProtectionPolicyBindingRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Returns the auto protection policy bindings read from the CCFE tables.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings", +"httpMethod": "GET", +"id": "backupdr.projects.locations.autoProtectionPolicies.bindings.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter expression that filters resources listed in the response. The following fields are filterable:", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. An expression that sorts the results in the response. The following fields are sortable:", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of policies to return in a single page. If unspecified, a server-default value will be used.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListAutoProtectionPolicies` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location for which to retrieve the list of policies. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/bindings", +"response": { +"$ref": "ListAutoProtectionPolicyBindingsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"matchingResources": { +"methods": { +"get": { +"description": "Gets details of a single Binding Matching Resource.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings/{bindingsId}/matchingResources/{matchingResourcesId}", +"httpMethod": "GET", +"id": "backupdr.projects.locations.autoProtectionPolicies.bindings.matchingResources.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the matching resource to retrieve. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+/bindings/[^/]+/matchingResources/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "BindingMatchingResource" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Binding Matching Resources for a given AutoProtectionPolicyBinding.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings/{bindingsId}/matchingResources", +"httpMethod": "GET", +"id": "backupdr.projects.locations.autoProtectionPolicies.bindings.matchingResources.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Field match expression used to filter the results.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Field by which to sort the results.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of `BindingMatchingResources` to return in a single response. The default page size is 100 and maximum page size is 200. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The value of next_page_token received from a previous `ListBindingMatchingResources` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBindingMatchingResources` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project, location, auto protection policy and binding for which to retrieve `BindingMatchingResources` information. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}`. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+/bindings/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/matchingResources", +"response": { +"$ref": "ListBindingMatchingResourcesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, +"backupPlanAssociations": { +"methods": { +"create": { +"description": "Create a BackupPlanAssociation", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations", +"httpMethod": "POST", +"id": "backupdr.projects.locations.backupPlanAssociations.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"backupPlanAssociationId": { +"description": "Required. The name of the backup plan association to create. The name must be unique for the specified project and location.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The backup plan association project and location in the format `projects/{project_id}/locations/{location}`. In Backup and DR locations map to Google Cloud regions, for example **us-central1**.", +"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 t he 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}/backupPlanAssociations", +"request": { +"$ref": "BackupPlanAssociation" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single BackupPlanAssociation.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}", +"httpMethod": "DELETE", +"id": "backupdr.projects.locations.backupPlanAssociations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"autoProtectionPolicyBinding": { +"description": "Optional. This field is exclusively used by Backup and DR's auto-protection feature. The resource name of the `AutoProtectionPolicyBinding` that triggered the deletion of this association. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}`.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPlanAssociations/[^/]+$", +"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": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetchForResourceType": { +"description": "List BackupPlanAssociations for a given resource type.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations:fetchForResourceType", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupPlanAssociations.fetchForResourceType", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields: * resource * backup_plan * state * data_source * cloud_sql_instance_backup_plan_association_properties.instance_create_time", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * name", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of BackupPlanAssociations to return. The service may return fewer than this value. If unspecified, at most 50 BackupPlanAssociations will be returned. The maximum value is 100; values above 100 will be coerced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous call of `FetchBackupPlanAssociationsForResourceType`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchBackupPlanAssociationsForResourceType` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource name. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"resourceType": { +"description": "Required. The type of the Google Cloud resource. Ex: sql.googleapis.com/Instance", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+parent}/backupPlanAssociations:fetchForResourceType", +"response": { +"$ref": "FetchBackupPlanAssociationsForResourceTypeResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single BackupPlanAssociation.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupPlanAssociations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPlanAssociations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "BackupPlanAssociation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists BackupPlanAssociations in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupPlanAssociations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering 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. The project and location for which to retrieve backup Plan Associations information, in the format `projects/{project_id}/locations/{location}`. In Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backup plan associations for all locations, use \"-\" for the `{location}` value.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/backupPlanAssociations", +"response": { +"$ref": "ListBackupPlanAssociationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update a BackupPlanAssociation.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}", +"httpMethod": "PATCH", +"id": "backupdr.projects.locations.backupPlanAssociations.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPlanAssociations/[^/]+$", +"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 t he 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": "Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlanAssociation 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 the request will fail. Currently backup_plan_association.backup_plan is the only supported field.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "BackupPlanAssociation" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"triggerBackup": { +"description": "Triggers a new Backup.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}:triggerBackup", +"httpMethod": "POST", +"id": "backupdr.projects.locations.backupPlanAssociations.triggerBackup", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPlanAssociations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}:triggerBackup", +"request": { +"$ref": "TriggerBackupRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"backupPlans": { +"methods": { +"create": { +"description": "Create a BackupPlan", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupPlans", +"httpMethod": "POST", +"id": "backupdr.projects.locations.backupPlans.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"backupPlanId": { +"description": "Required. The name of the `BackupPlan` to create. The name must be unique for the specified project and location.The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The `BackupPlan` project and location in the format `projects/{project}/locations/{location}`. In Google Cloud Backup and DR locations map to Google Cloud regions, for example **us-central1**.", +"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 t he 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}/backupPlans", +"request": { +"$ref": "BackupPlan" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single BackupPlan.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}", +"httpMethod": "DELETE", +"id": "backupdr.projects.locations.backupPlans.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the `BackupPlan` to delete. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$", +"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": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single BackupPlan.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupPlans.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the `BackupPlan` to retrieve. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "BackupPlan" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists BackupPlans in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupPlans", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupPlans.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Field match expression used to filter the results.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Field by which to sort the results.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of `BackupPlans` to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlans` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location for which to retrieve `BackupPlans` information. Format: `projects/{project}/locations/{location}`. In Google Cloud Backup and DR, locations map to Google Cloud regions, for e.g. **us-central1**. To retrieve backup plans for all locations, use \"-\" for the `{location}` value.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/backupPlans", +"response": { +"$ref": "ListBackupPlansResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update a BackupPlan.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}", +"httpMethod": "PATCH", +"id": "backupdr.projects.locations.backupPlans.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$", +"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 t he 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": "Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan 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 the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "BackupPlan" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"revisions": { +"methods": { +"get": { +"description": "Gets details of a single BackupPlanRevision.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/revisions/{revisionsId}", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupPlans.revisions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the `BackupPlanRevision` to retrieve. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/revisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "BackupPlanRevision" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists BackupPlanRevisions in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/revisions", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupPlans.revisions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of `BackupPlans` to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlans` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location for which to retrieve `BackupPlanRevisions` information. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`. In Google Cloud Backup and DR, locations map to Google Cloud regions, for e.g. **us-central1**.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/revisions", +"response": { +"$ref": "ListBackupPlanRevisionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"backupVaults": { +"methods": { +"create": { +"description": "Creates a new BackupVault in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults", +"httpMethod": "POST", +"id": "backupdr.projects.locations.backupVaults.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"backupVaultId": { +"description": "Required. ID of the requesting object If auto-generating ID server-side, remove this field and backup_vault_id from the method_signature of Create RPC", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Value for parent.", +"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" +}, +"validateOnly": { +"description": "Optional. Only validate the request, but do not perform mutations. The default is 'false'.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta/{+parent}/backupVaults", +"request": { +"$ref": "BackupVault" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a BackupVault.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", +"httpMethod": "DELETE", +"id": "backupdr.projects.locations.backupVaults.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"allowMissing": { +"description": "Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken.", +"location": "query", +"type": "boolean" +}, +"etag": { +"description": "The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked.", +"location": "query", +"type": "string" +}, +"force": { +"description": "Optional. If set to true, any data source from this backup vault will also be deleted.", +"location": "query", +"type": "boolean" +}, +"ignoreBackupPlanReferences": { +"description": "Optional. If set to true, backupvault deletion will proceed even if there are backup plans referencing the backupvault. The default is 'false'.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. Name of the resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", +"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" +}, +"validateOnly": { +"description": "Optional. Only validate the request, but do not perform mutations. The default is 'false'.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetchUsable": { +"description": "FetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults:fetchUsable", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupVaults.fetchUsable", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results.", +"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. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use \"-\" for the '{location}' value.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/backupVaults:fetchUsable", +"response": { +"$ref": "FetchUsableBackupVaultsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a BackupVault.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupVaults.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the backupvault store resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}'", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault", +"enum": [ +"BACKUP_VAULT_VIEW_UNSPECIFIED", +"BACKUP_VAULT_VIEW_BASIC", +"BACKUP_VAULT_VIEW_FULL" +], +"enumDescriptions": [ +"If the value is not set, the default 'FULL' view is used.", +"Includes basic data about the Backup Vault, but not the full contents.", +"Includes all data about the Backup Vault. This is the default value (for both ListBackupVaults and GetBackupVault)." +], +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "BackupVault" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists BackupVaults in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupVaults.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results.", +"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. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use \"-\" for the '{location}' value.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault.", +"enum": [ +"BACKUP_VAULT_VIEW_UNSPECIFIED", +"BACKUP_VAULT_VIEW_BASIC", +"BACKUP_VAULT_VIEW_FULL" +], +"enumDescriptions": [ +"If the value is not set, the default 'FULL' view is used.", +"Includes basic data about the Backup Vault, but not the full contents.", +"Includes all data about the Backup Vault. This is the default value (for both ListBackupVaults and GetBackupVault)." +], +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+parent}/backupVaults", +"response": { +"$ref": "ListBackupVaultsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the settings of a BackupVault.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", +"httpMethod": "PATCH", +"id": "backupdr.projects.locations.backupVaults.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "Optional. If set to true, will not check plan duration against backup vault enforcement duration.", +"location": "query", +"type": "boolean" +}, +"forceUpdateAccessRestriction": { +"description": "Optional. If set to true, we will force update access restriction even if some non compliant data sources are present. The default is 'false'.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Output only. Identifier. Name of the backup vault to create. It must have the format`\"projects/{project}/locations/{location}/backupVaults/{backupvault}\"`. `{backupvault}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", +"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": "Required. Field mask is used to specify the fields to be overwritten in the BackupVault 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 the request will fail.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. Only validate the request, but do not perform mutations. The default is 'false'.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "BackupVault" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns the caller's permissions on a BackupVault resource. A caller is not required to have Google IAM permission to make this request.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}:testIamPermissions", +"httpMethod": "POST", +"id": "backupdr.projects.locations.backupVaults.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/[^/]+/backupVaults/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"dataSources": { +"methods": { +"abandonBackup": { +"description": "Internal only. Abandons a backup.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:abandonBackup", +"httpMethod": "POST", +"id": "backupdr.projects.locations.backupVaults.dataSources.abandonBackup", +"parameterOrder": [ +"dataSource" +], +"parameters": { +"dataSource": { +"description": "Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+dataSource}:abandonBackup", +"request": { +"$ref": "AbandonBackupRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetchAccessToken": { +"description": "Internal only. Fetch access token for a given data source.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:fetchAccessToken", +"httpMethod": "POST", +"id": "backupdr.projects.locations.backupVaults.dataSources.fetchAccessToken", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name for the location for which static IPs should be returned. Must be in the format 'projects/*/locations/*/backupVaults/*/dataSources'.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}:fetchAccessToken", +"request": { +"$ref": "FetchAccessTokenRequest" +}, +"response": { +"$ref": "FetchAccessTokenResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"finalizeBackup": { +"description": "Internal only. Finalize a backup that was started by a call to InitiateBackup.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:finalizeBackup", +"httpMethod": "POST", +"id": "backupdr.projects.locations.backupVaults.dataSources.finalizeBackup", +"parameterOrder": [ +"dataSource" +], +"parameters": { +"dataSource": { +"description": "Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+dataSource}:finalizeBackup", +"request": { +"$ref": "FinalizeBackupRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a DataSource.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupVaults.dataSources.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}/dataSource/{resource_name}'", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "DataSource" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"initiateBackup": { +"description": "Internal only. Initiates a backup.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:initiateBackup", +"httpMethod": "POST", +"id": "backupdr.projects.locations.backupVaults.dataSources.initiateBackup", +"parameterOrder": [ +"dataSource" +], +"parameters": { +"dataSource": { +"description": "Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+dataSource}:initiateBackup", +"request": { +"$ref": "InitiateBackupRequest" +}, +"response": { +"$ref": "InitiateBackupResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists DataSources in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupVaults.dataSources.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results.", +"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. The project and location for which to retrieve data sources information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use \"-\" for the '{location}' value.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/dataSources", +"response": { +"$ref": "ListDataSourcesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the settings of a DataSource.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}", +"httpMethod": "PATCH", +"id": "backupdr.projects.locations.backupVaults.dataSources.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"allowMissing": { +"description": "Optional. Enable upsert.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Output only. Identifier. Name of the datasource to create. It must have the format`\"projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}\"`. `{datasource}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the backup vault.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", +"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": "Required. Field mask is used to specify the fields to be overwritten in the DataSource 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 the request will fail.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "DataSource" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"remove": { +"description": "Deletes a DataSource. This is a custom method instead of a standard delete method because external clients will not delete DataSources except for BackupDR backup appliances.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:remove", +"httpMethod": "POST", +"id": "backupdr.projects.locations.backupVaults.dataSources.remove", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}:remove", +"request": { +"$ref": "RemoveDataSourceRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setInternalStatus": { +"description": "Sets the internal status of a DataSource.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:setInternalStatus", +"httpMethod": "POST", +"id": "backupdr.projects.locations.backupVaults.dataSources.setInternalStatus", +"parameterOrder": [ +"dataSource" +], +"parameters": { +"dataSource": { +"description": "Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+dataSource}:setInternalStatus", +"request": { +"$ref": "SetInternalStatusRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"backups": { +"methods": { +"delete": { +"description": "Deletes a Backup.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}", +"httpMethod": "DELETE", +"id": "backupdr.projects.locations.backupVaults.dataSources.backups.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$", +"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": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetchForResourceType": { +"description": "Fetch Backups for a given resource type.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups:fetchForResourceType", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupVaults.dataSources.backups.fetchForResourceType", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields: * name * state * backup_type * create_time * expire_time * enforced_retention_end_time * gcp_backup_plan_info.backup_plan * cloud_sql_instance_backup_properties.instance_tier * cloud_sql_instance_backup_properties.database_installed_version", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * name", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of Backups to return. The service may return fewer than this value. If unspecified, at most 50 Backups will be returned. The maximum value is 100; values above 100 will be coerced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous call of `FetchBackupsForResourceType`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchBackupsForResourceType` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Datasources are the parent resource for the backups. Format: projects/{project}/locations/{location}/backupVaults/{backupVaultId}/dataSources/{datasourceId}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", +"required": true, +"type": "string" +}, +"resourceType": { +"description": "Required. The type of the GCP resource. Ex: sqladmin.googleapis.com/Instance", +"location": "query", +"type": "string" +}, +"view": { +"description": "Optional. This parameter is used to specify the view of the backup. If not specified, the default view is BASIC.", +"enum": [ +"BACKUP_VIEW_UNSPECIFIED", +"BACKUP_VIEW_BASIC", +"BACKUP_VIEW_FULL" +], +"enumDescriptions": [ +"If the value is not set, the default 'FULL' view is used.", +"Includes basic data about the Backup, but not the full contents.", +"Includes all data about the Backup. This is the default value (for both ListBackups and GetBackup)." +], +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+parent}/backups:fetchForResourceType", +"response": { +"$ref": "FetchBackupsForResourceTypeResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a Backup.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupVaults.dataSources.backups.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{backupVault}/dataSources/{datasource}/backups/{backup}'", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. Reserved for future use to provide a BASIC & FULL view of Backup resource.", +"enum": [ +"BACKUP_VIEW_UNSPECIFIED", +"BACKUP_VIEW_BASIC", +"BACKUP_VIEW_FULL" +], +"enumDescriptions": [ +"If the value is not set, the default 'FULL' view is used.", +"Includes basic data about the Backup, but not the full contents.", +"Includes all data about the Backup. This is the default value (for both ListBackups and GetBackup)." +], +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "Backup" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Backups in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupVaults.dataSources.backups.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results.", +"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. The project and location for which to retrieve backup information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use \"-\" for the '{location}' value.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. Reserved for future use to provide a BASIC & FULL view of Backup resource.", +"enum": [ +"BACKUP_VIEW_UNSPECIFIED", +"BACKUP_VIEW_BASIC", +"BACKUP_VIEW_FULL" +], +"enumDescriptions": [ +"If the value is not set, the default 'FULL' view is used.", +"Includes basic data about the Backup, but not the full contents.", +"Includes all data about the Backup. This is the default value (for both ListBackups and GetBackup)." +], +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+parent}/backups", +"response": { +"$ref": "ListBackupsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the settings of a Backup.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}", +"httpMethod": "PATCH", +"id": "backupdr.projects.locations.backupVaults.dataSources.backups.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Output only. Identifier. Name of the backup to create. It must have the format`\"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}\"`. `{backup}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$", +"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": "Required. Field mask is used to specify the fields to be overwritten in the Backup 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 the request will fail.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "Backup" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"restore": { +"description": "Restore from a Backup", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}:restore", +"httpMethod": "POST", +"id": "backupdr.projects.locations.backupVaults.dataSources.backups.restore", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Backup instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/*/backups/'.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}:restore", +"request": { +"$ref": "RestoreBackupRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, +"dataSourceReferences": { +"methods": { +"fetchForResourceType": { +"description": "Fetch DataSourceReferences for a given project, location and resource type.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataSourceReferences:fetchForResourceType", +"httpMethod": "GET", +"id": "backupdr.projects.locations.dataSourceReferences.fetchForResourceType", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields: * data_source * data_source_gcp_resource_info.gcp_resourcename * data_source_backup_config_state * data_source_backup_count * data_source_backup_config_info.last_backup_state * data_source_gcp_resource_info.gcp_resourcename * data_source_gcp_resource_info.type * data_source_gcp_resource_info.location * data_source_gcp_resource_info.cloud_sql_instance_properties.instance_create_time", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * name", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous call of `FetchDataSourceReferencesForResourceType`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDataSourceReferencesForResourceType` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource name. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"resourceType": { +"description": "Required. The type of the Google Cloud resource. Ex: sql.googleapis.com/Instance", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+parent}/dataSourceReferences:fetchForResourceType", +"response": { +"$ref": "FetchDataSourceReferencesForResourceTypeResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single DataSourceReference.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataSourceReferences/{dataSourceReferencesId}", +"httpMethod": "GET", +"id": "backupdr.projects.locations.dataSourceReferences.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the DataSourceReference to retrieve. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataSourceReferences/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "DataSourceReference" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists DataSourceReferences for a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataSourceReferences", +"httpMethod": "GET", +"id": "backupdr.projects.locations.dataSourceReferences.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter expression that filters the results listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The following field and operator combinations are supported: * data_source_gcp_resource_info.gcp_resourcename with `=`, `!=` * data_source_gcp_resource_info.type with `=`, `!=`", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * data_source * data_source_gcp_resource_info.gcp_resourcename", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListDataSourceReferences` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataSourceReferences` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource name. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/dataSourceReferences", +"response": { +"$ref": "ListDataSourceReferencesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"managementServers": { +"methods": { +"create": { +"description": "Creates a new ManagementServer in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/managementServers", +"httpMethod": "POST", +"id": "backupdr.projects.locations.managementServers.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"managementServerId": { +"description": "Required. The name of the management server to create. The name must be unique for the specified project and location.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The management server project and location in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR locations map to Google Cloud regions, for example **us-central1**.", +"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}/managementServers", +"request": { +"$ref": "ManagementServer" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single ManagementServer.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}", +"httpMethod": "DELETE", +"id": "backupdr.projects.locations.managementServers.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$", +"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": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single ManagementServer.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}", +"httpMethod": "GET", +"id": "backupdr.projects.locations.managementServers.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the management server resource name, in the format 'projects/{project_id}/locations/{location}/managementServers/{resource_name}'", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "ManagementServer" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"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}/managementServers/{managementServersId}:getIamPolicy", +"httpMethod": "GET", +"id": "backupdr.projects.locations.managementServers.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/[^/]+/managementServers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists ManagementServers in a given project and location.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/managementServers", +"httpMethod": "GET", +"id": "backupdr.projects.locations.managementServers.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results.", +"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. The project and location for which to retrieve management servers information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve management servers for all locations, use \"-\" for the '{location}' value.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/managementServers", +"response": { +"$ref": "ListManagementServersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"msComplianceMetadata": { +"description": "Returns the Assured Workloads compliance metadata for a given project.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/managementServers:msComplianceMetadata", +"httpMethod": "POST", +"id": "backupdr.projects.locations.managementServers.msComplianceMetadata", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The project and location to be used to check CSS metadata for target project information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/managementServers$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}:msComplianceMetadata", +"request": { +"$ref": "FetchMsComplianceMetadataRequest" +}, +"response": { +"$ref": "FetchMsComplianceMetadataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"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}/managementServers/{managementServersId}:setIamPolicy", +"httpMethod": "POST", +"id": "backupdr.projects.locations.managementServers.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/[^/]+/managementServers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"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}/managementServers/{managementServersId}:testIamPermissions", +"httpMethod": "POST", +"id": "backupdr.projects.locations.managementServers.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/[^/]+/managementServers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"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": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "backupdr.projects.locations.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}:cancel", +"request": { +"$ref": "CancelOperationRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"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": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "backupdr.projects.locations.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"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": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "backupdr.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": "v1beta/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"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": "v1beta/projects/{projectsId}/locations/{locationsId}/operations", +"httpMethod": "GET", +"id": "backupdr.projects.locations.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. 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": "v1beta/{+name}/operations", +"response": { +"$ref": "ListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"resourceBackupConfigs": { +"methods": { +"fetch": { +"description": "Fetches ResourceBackupConfigs.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/resourceBackupConfigs:fetch", +"httpMethod": "GET", +"id": "backupdr.projects.locations.resourceBackupConfigs.fetch", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results.", +"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 use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500.", +"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 project, folder or organization and location for which to retrieve resource backup configs. Format: 'projects/{project_id}/locations/{location}', 'folders/{folder_id}/locations/{location}', or 'organizations/{organization_id}/locations/{location}'.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/resourceBackupConfigs:fetch", +"response": { +"$ref": "FetchResourceBackupConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists ResourceBackupConfigs.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/resourceBackupConfigs", +"httpMethod": "GET", +"id": "backupdr.projects.locations.resourceBackupConfigs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results.", +"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 use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500.", +"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 project and location for which to retrieve resource backup configs. Format: 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/resourceBackupConfigs", +"response": { +"$ref": "ListResourceBackupConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"serviceConfig": { +"methods": { +"initialize": { +"description": "Initializes the service related config for a project.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/serviceConfig:initialize", +"httpMethod": "POST", +"id": "backupdr.projects.locations.serviceConfig.initialize", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the serviceConfig used to initialize the service. The location must be the location of the BackupVault. Format: `projects/{project_id}/locations/{location}/serviceConfig`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/serviceConfig$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}:initialize", +"request": { +"$ref": "InitializeServiceRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"trial": { +"methods": { +"end": { +"description": "Ends the trial for a project", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/trial:end", +"httpMethod": "POST", +"id": "backupdr.projects.locations.trial.end", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource where the trial has been created. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/trial:end", +"request": { +"$ref": "EndTrialRequest" +}, +"response": { +"$ref": "Trial" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"subscribe": { +"description": "Subscribes to a trial for a project", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/trial:subscribe", +"httpMethod": "POST", +"id": "backupdr.projects.locations.trial.subscribe", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The project where this trial will be created. Format: projects/{project}/locations/{location} Supported Locations are - us, eu and asia.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/trial:subscribe", +"request": { +"$ref": "SubscribeTrialRequest" +}, +"response": { +"$ref": "Trial" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +}, +"revision": "20260826", +"rootUrl": "https://backupdr.googleapis.com/", +"schemas": { +"AbandonBackupRequest": { +"description": "request message for AbandonBackup.", +"id": "AbandonBackupRequest", +"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 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).", +"type": "string" +} +}, +"type": "object" +}, +"AcceleratorConfig": { +"description": "A specification of the type and number of accelerator cards attached to the instance.", +"id": "AcceleratorConfig", +"properties": { +"acceleratorCount": { +"description": "Optional. The number of the guest accelerator cards exposed to this instance.", +"format": "int32", +"type": "integer" +}, +"acceleratorType": { +"description": "Optional. Full or partial URL of the accelerator type resource to attach to this instance.", +"type": "string" +} +}, +"type": "object" +}, +"AccessConfig": { +"description": "An access configuration attached to an instance's network interface. Only one access config per instance is supported.", +"id": "AccessConfig", +"properties": { +"externalIpv6": { +"description": "Optional. The external IPv6 address of this access configuration.", +"type": "string" +}, +"externalIpv6PrefixLength": { +"description": "Optional. The prefix length of the external IPv6 range.", +"format": "int32", +"type": "integer" +}, +"name": { +"description": "Optional. The name of this access configuration.", +"type": "string" +}, +"natIP": { +"description": "Optional. The external IP address of this access configuration.", +"type": "string" +}, +"networkTier": { +"description": "Optional. This signifies the networking tier used for configuring this access", +"enum": [ +"NETWORK_TIER_UNSPECIFIED", +"PREMIUM", +"STANDARD" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"High quality, Google-grade network tier, support for all networking products.", +"Public internet quality, only limited support for other networking products." +], +"type": "string" +}, +"publicPtrDomainName": { +"description": "Optional. The DNS domain name for the public PTR record.", +"type": "string" +}, +"setPublicPtr": { +"description": "Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.", +"type": "boolean" +}, +"type": { +"description": "Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.", +"enum": [ +"ACCESS_TYPE_UNSPECIFIED", +"ONE_TO_ONE_NAT", +"DIRECT_IPV6" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"ONE_TO_ONE_NAT", +"Direct IPv6 access." +], +"type": "string" +} +}, +"type": "object" +}, +"AdvancedMachineFeatures": { +"description": "Specifies options for controlling advanced machine features.", +"id": "AdvancedMachineFeatures", +"properties": { +"enableNestedVirtualization": { +"description": "Optional. Whether to enable nested virtualization or not (default is false).", +"type": "boolean" +}, +"enableUefiNetworking": { +"description": "Optional. Whether to enable UEFI networking for instance creation.", +"type": "boolean" +}, +"threadsPerCore": { +"description": "Optional. The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.", +"format": "int32", +"type": "integer" +}, +"visibleCoreCount": { +"description": "Optional. The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"AliasIpRange": { +"description": "An alias IP range attached to an instance's network interface.", +"id": "AliasIpRange", +"properties": { +"ipCidrRange": { +"description": "Optional. The IP alias ranges to allocate for this interface.", +"type": "string" +}, +"subnetworkRangeName": { +"description": "Optional. The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.", +"type": "string" +} +}, +"type": "object" +}, +"AllocationAffinity": { +"description": "Specifies the reservations that this instance can consume from.", +"id": "AllocationAffinity", +"properties": { +"consumeReservationType": { +"description": "Optional. Specifies the type of reservation from which this instance can consume", +"enum": [ +"TYPE_UNSPECIFIED", +"NO_RESERVATION", +"ANY_RESERVATION", +"SPECIFIC_RESERVATION" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Do not consume from any allocated capacity.", +"Consume any allocation available.", +"Must consume from a specific reservation. Must specify key value fields for specifying the reservations." +], +"type": "string" +}, +"key": { +"description": "Optional. Corresponds to the label key of a reservation resource.", +"type": "string" +}, +"values": { +"description": "Optional. Corresponds to the label values of a reservation resource.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AlloyDBClusterBackupPlanAssociationProperties": { +"description": "Properties for an AlloyDB cluster backup plan association.", +"id": "AlloyDBClusterBackupPlanAssociationProperties", +"properties": { +"clusterUid": { +"description": "Output only. The cluster UID of the AlloyDB cluster.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AlloyDBClusterDataSourceProperties": { +"description": "AlloyDBClusterDataSourceProperties represents the properties of a AlloyDB cluster resource that are stored in the DataSource. .", +"id": "AlloyDBClusterDataSourceProperties", +"properties": { +"clusterUid": { +"description": "Output only. The cluster UID of the AlloyDB cluster backed up by the datasource.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Name of the AlloyDB cluster backed up by the datasource.", +"readOnly": true, +"type": "string" +}, +"pitrWindows": { +"description": "Output only. Point in time recovery windows. The order is guaranteed to be ascending by start time.", +"items": { +"$ref": "AlloyDbPitrWindow" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"AlloyDBClusterDataSourceReferenceProperties": { +"description": "AlloyDBClusterDataSourceReferenceProperties represents the properties of an AlloyDB cluster that are stored in the DataSourceReference.", +"id": "AlloyDBClusterDataSourceReferenceProperties", +"properties": { +"name": { +"description": "Output only. Name of the AlloyDB cluster backed up by the datasource. Format: projects/{project}/locations/{location}/clusters/{cluster}", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AlloyDbClusterBackupProperties": { +"description": "AlloyDbClusterBackupProperties represents AlloyDB cluster backup properties. .", +"id": "AlloyDbClusterBackupProperties", +"properties": { +"chainId": { +"description": "Output only. The chain id of this backup. Backups belonging to the same chain are sharing the same chain id. This property is calculated and maintained by BackupDR.", +"readOnly": true, +"type": "string" +}, +"databaseVersion": { +"description": "Output only. The PostgreSQL major version of the AlloyDB cluster when the backup was taken.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "An optional text description for the backup.", +"type": "string" +}, +"storedBytes": { +"description": "Output only. Storage usage of this particular backup", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AlloyDbPitrWindow": { +"description": "Point in time recovery window for an AlloyDB cluster.", +"id": "AlloyDbPitrWindow", +"properties": { +"endTime": { +"description": "Output only. The end time of the PITR window. It is not set if the corresponding Backup Plan Association is active.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"logRetentionDays": { +"description": "Output only. Log retention days for the PITR window.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"startTime": { +"description": "Output only. The start time of the PITR window.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AppliedAutoProtectionPolicy": { +"description": "AppliedAutoProtectionPolicy is a read-only view of AutoProtectionPolicy and AutoProtectionPolicyBinding resources that apply to a given workload project.", +"id": "AppliedAutoProtectionPolicy", +"properties": { +"backupPlanDetails": { +"description": "Output only. The set of backup plan configurations, mirroring the backup_plan_details from the source AutoProtectionPolicy. Each element specifies a backup plan for a given resource type.", +"items": { +"$ref": "BackupPlanDetail" +}, +"readOnly": true, +"type": "array" +}, +"bindingEvaluationSummary": { +"$ref": "BindingEvaluationSummary", +"description": "Output only. The summary of the last policy application when the job has run.", +"readOnly": true +}, +"createTime": { +"description": "Output only. Timestamp indicating when the binding was last created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"criteria": { +"$ref": "Criteria", +"description": "Output only. The criteria resources must meet for this rule to apply. From AutoProtectionPolicy.criteria.", +"readOnly": true +}, +"name": { +"description": "Identifier. Canonical resource name. Format: projects/{workload-project-number}/locations/{location}/appliedAutoProtectionPolicies/{id}.", +"type": "string" +}, +"sourceBinding": { +"description": "Output only. The full resource name of the AutoProtectionPolicyBinding that applies the source policy to a scope including this workload project. e.g., projects/{admin-project}/locations/{location}/autoProtectionPolicies/{policy_id}/autoProtectionPolicyBindings/{binding_id}.", +"readOnly": true, +"type": "string" +}, +"status": { +"description": "Output only. The status of the applied auto protection policy.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"DELETION_INITIATED" +], +"enumDescriptions": [ +"State is not specified.", +"The policy is in the process of being applied.", +"The policy has been applied and is active.", +"The policy is in the process of being removed." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp indicating when the binding was last modified.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AttachedDisk": { +"description": "An instance-attached disk resource.", +"id": "AttachedDisk", +"properties": { +"autoDelete": { +"description": "Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).", +"type": "boolean" +}, +"boot": { +"description": "Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.", +"type": "boolean" +}, +"deviceName": { +"description": "Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like disk_name and replica_zones (in case of RePDs)", +"type": "string" +}, +"diskEncryptionKey": { +"$ref": "CustomerEncryptionKey", +"description": "Optional. Encrypts or decrypts a disk using a customer-supplied encryption key." +}, +"diskInterface": { +"description": "Optional. Specifies the disk interface to use for attaching this disk.", +"enum": [ +"DISK_INTERFACE_UNSPECIFIED", +"SCSI", +"NVME", +"NVDIMM", +"ISCSI" +], +"enumDescriptions": [ +"Default value, which is unused.", +"SCSI Disk Interface.", +"NVME Disk Interface.", +"NVDIMM Disk Interface.", +"ISCSI Disk Interface." +], +"type": "string" +}, +"diskSizeGb": { +"description": "Optional. The size of the disk in GB.", +"format": "int64", +"type": "string" +}, +"diskType": { +"description": "Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd", +"readOnly": true, +"type": "string" +}, +"diskTypeDeprecated": { +"deprecated": true, +"description": "Specifies the type of the disk.", +"enum": [ +"DISK_TYPE_UNSPECIFIED", +"SCRATCH", +"PERSISTENT" +], +"enumDescriptions": [ +"Default value, which is unused.", +"A scratch disk type.", +"A persistent disk type." +], +"type": "string" +}, +"guestOsFeature": { +"description": "Optional. A list of features to enable on the guest operating system. Applicable only for bootable images.", +"items": { +"$ref": "GuestOsFeature" +}, +"type": "array" +}, +"index": { +"description": "Optional. A zero-based index to this disk, where 0 is reserved for the boot disk.", +"format": "int64", +"type": "string" +}, +"initializeParams": { +"$ref": "InitializeParams", +"description": "Optional. Specifies the parameters to initialize this disk." +}, +"kind": { +"description": "Optional. Type of the resource.", +"type": "string" +}, +"license": { +"description": "Optional. Any valid publicly visible licenses.", +"items": { +"type": "string" +}, +"type": "array" +}, +"mode": { +"description": "Optional. The mode in which to attach this disk.", +"enum": [ +"DISK_MODE_UNSPECIFIED", +"READ_WRITE", +"READ_ONLY", +"LOCKED" +], +"enumDescriptions": [ +"Default value, which is unused.", +"Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode.", +"Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.", +"The disk is locked for administrative reasons. Nobody else can use the disk. This mode is used (for example) when taking a snapshot of a disk to prevent mounting the disk while it is being snapshotted." +], +"type": "string" +}, +"savedState": { +"description": "Optional. Output only. The state of the disk.", +"enum": [ +"DISK_SAVED_STATE_UNSPECIFIED", +"PRESERVED" +], +"enumDescriptions": [ +"Default Disk state has not been preserved.", +"Disk state has been preserved." +], +"readOnly": true, +"type": "string" +}, +"source": { +"description": "Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource.", +"type": "string" +}, +"type": { +"description": "Optional. Specifies the type of the disk.", +"enum": [ +"DISK_TYPE_UNSPECIFIED", +"SCRATCH", +"PERSISTENT" +], +"enumDescriptions": [ +"Default value, which is unused.", +"A scratch disk type.", +"A persistent disk type." +], +"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" +}, +"AutoProtectionDetails": { +"description": "AutoProtectionDetails contains the protection details of a resource from the current binding's perspective.", +"id": "AutoProtectionDetails", +"properties": { +"backupPlanAssociation": { +"description": "Output only. Resource name of backup plan association linked to the resource, if any. Format: projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}", +"readOnly": true, +"type": "string" +}, +"dataSource": { +"description": "Output only. Resource name of the datasource linked to the resource, if any. Format: projects/{project}/locations/{location}/backupVaults/{backupVaultId}/dataSources/{dataSourceId}", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "Status", +"description": "Output only. Error during last sync for protection/unprotection, if any.", +"readOnly": true +}, +"state": { +"description": "Output only. Protection state of the resource from the current binding's perspective. Output only.", +"enum": [ +"STATE_UNSPECIFIED", +"PROTECTED", +"PROTECTION_FAILED", +"UNPROTECTING", +"UNPROTECTION_FAILED" +], +"enumDescriptions": [ +"State unspecified.", +"Resource is protected.", +"Resource protection failed.", +"Resource is being unprotected.", +"Resource unprotection failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AutoProtectionPolicy": { +"description": "An AutoprotectionPolicy is a policy resource designed to automate backup management, moving from manual per-resource protection to a bulk approach. The policy dynamically discovers and applies a specified backup plan to all eligible resources that match its defined scope and criteria.", +"id": "AutoProtectionPolicy", +"properties": { +"backupPlanDetails": { +"description": "Required. The backup plan details for matching resources.", +"items": { +"$ref": "BackupPlanDetail" +}, +"type": "array" +}, +"bindingSummary": { +"$ref": "BindingSummary", +"description": "Output only. Summary of total count of different containers covered through this policy.", +"readOnly": true +}, +"createTime": { +"description": "Output only. The timestamp when the policy was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"criteria": { +"$ref": "Criteria", +"description": "Required. The criteria for matching resources." +}, +"description": { +"description": "Optional. A description of the policy.", +"type": "string" +}, +"etag": { +"description": "Output only. The etag for the policy. If this is provided on update, it must match the server's etag, otherwise the request will be rejected with an ABORTED error.", +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the AutoprotectionPolicy. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}`", +"type": "string" +}, +"policyEvaluationSummary": { +"$ref": "PolicyEvaluationSummary", +"description": "Output only. Summary of last policy application when job was run per workload type.", +"readOnly": true +}, +"state": { +"description": "Output only. The current state of the AutoprotectionPolicy.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"UPDATING", +"DELETING" +], +"enumDescriptions": [ +"The state of the policy is unspecified.", +"The policy is being created.", +"The policy is active and protecting matching resources.", +"The policy is being updated.", +"The policy is being deleted." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the policy was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AutoProtectionPolicyBinding": { +"description": "An AutoprotectionPolicyBinding (APPA) acts as the bridge between an AutoprotectionPolicy and the scope (Project, Folder, or Organization) where the policy should be applied.", +"id": "AutoProtectionPolicyBinding", +"properties": { +"bindingEvaluationSummary": { +"$ref": "BindingEvaluationSummary", +"description": "Output only. Summaries of the last policy application when the job has run, with one entry per resource type specified in the AutoProtectionPolicy.", +"readOnly": true +}, +"createTime": { +"description": "Output only. The timestamp when the binding was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. A description of the binding.", +"type": "string" +}, +"etag": { +"description": "Optional. Output only. The etag for the binding. If this is provided on update, it must match the server's etag.", +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the AutoProtectionPolicyBinding. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}`", +"type": "string" +}, +"scope": { +"description": "Required. Immutable. Resource Id of target container on which policy will be applied. Format: projects/{project_id}", +"type": "string" +}, +"state": { +"description": "Output only. The current state of the AutoProtectionPolicyBinding.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"DELETION_INITIATED" +], +"enumDescriptions": [ +"The state of the binding is unspecified.", +"The binding is being created.", +"The binding is active.", +"The binding deletion is initiated." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the binding was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Backup": { +"description": "Message describing a Backup object.", +"id": "Backup", +"properties": { +"alloyDbBackupProperties": { +"$ref": "AlloyDbClusterBackupProperties", +"description": "Output only. AlloyDB specific backup properties.", +"readOnly": true +}, +"backupApplianceBackupProperties": { +"$ref": "BackupApplianceBackupProperties", +"description": "Output only. Backup Appliance specific backup properties.", +"readOnly": true +}, +"backupApplianceLocks": { +"description": "Optional. The list of BackupLocks taken by the accessor Backup Appliance.", +"items": { +"$ref": "BackupLock" +}, +"type": "array" +}, +"backupRetentionInheritance": { +"description": "Output only. Setting for how the enforced retention end time is inherited. This value is copied from this backup's BackupVault.", +"enum": [ +"BACKUP_RETENTION_INHERITANCE_UNSPECIFIED", +"INHERIT_VAULT_RETENTION", +"MATCH_BACKUP_EXPIRE_TIME" +], +"enumDescriptions": [ +"Inheritance behavior not set. This will default to `INHERIT_VAULT_RETENTION`.", +"The enforced retention end time of a backup will be inherited from the backup vault's `backup_minimum_enforced_retention_duration` field. This is the default behavior.", +"The enforced retention end time of a backup will always match the expire time of the backup. If this is set, the backup's enforced retention end time will be set to match the expire time during creation of the backup. When updating, the ERET and expire time must be updated together and have the same value. Invalid update requests will be rejected by the server." +], +"readOnly": true, +"type": "string" +}, +"backupType": { +"description": "Output only. Type of the backup, unspecified, scheduled or ondemand.", +"enum": [ +"BACKUP_TYPE_UNSPECIFIED", +"SCHEDULED", +"ON_DEMAND", +"ON_DEMAND_OPERATIONAL" +], +"enumDescriptions": [ +"Backup type is unspecified.", +"Scheduled backup.", +"On demand backup.", +"Operational backup." +], +"readOnly": true, +"type": "string" +}, +"cloudSqlInstanceBackupProperties": { +"$ref": "CloudSqlInstanceBackupProperties", +"description": "Output only. Cloud SQL specific backup properties.", +"readOnly": true +}, +"computeInstanceBackupProperties": { +"$ref": "ComputeInstanceBackupProperties", +"description": "Output only. Compute Engine specific backup properties.", +"readOnly": true +}, +"consistencyTime": { +"description": "Output only. The point in time when this backup was captured from the source.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time when the instance was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Output only. The description of the Backup instance (2048 characters or less).", +"readOnly": true, +"type": "string" +}, +"diskBackupProperties": { +"$ref": "DiskBackupProperties", +"description": "Output only. Disk specific backup properties.", +"readOnly": true +}, +"enforcedRetentionEndTime": { +"description": "Optional. The backup can not be deleted before this time.", +"format": "google-datetime", +"type": "string" +}, +"etag": { +"description": "Optional. Server specified ETag to prevent updates from overwriting each other.", +"type": "string" +}, +"expireTime": { +"description": "Optional. When this backup is automatically expired.", +"format": "google-datetime", +"type": "string" +}, +"filestoreInstanceBackupProperties": { +"$ref": "FilestoreInstanceBackupProperties", +"description": "Output only. Filestore specific backup properties.", +"readOnly": true +}, +"gcpBackupPlanInfo": { +"$ref": "GCPBackupPlanInfo", +"description": "Output only. Configuration for a Google Cloud resource.", +"readOnly": true +}, +"gcpResource": { +"$ref": "BackupGcpResource", +"description": "Output only. Unique identifier of the GCP resource that is being backed up.", +"readOnly": true +}, +"kmsKeyVersions": { +"description": "Optional. Output only. The list of KMS key versions used to encrypt the backup.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Resource labels to represent user provided metadata. No labels currently defined.", +"type": "object" +}, +"name": { +"description": "Output only. Identifier. Name of the backup to create. It must have the format`\"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}\"`. `{backup}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.", +"readOnly": true, +"type": "string" +}, +"resourceSizeBytes": { +"description": "Output only. source resource size in bytes at the time of the backup.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"satisfiesPzi": { +"description": "Optional. Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Optional. Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"serviceLocks": { +"description": "Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.", +"items": { +"$ref": "BackupLock" +}, +"readOnly": true, +"type": "array" +}, +"state": { +"description": "Output only. The Backup resource instance state.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"DELETING", +"ERROR", +"UPLOADING" +], +"enumDescriptions": [ +"State not set.", +"The backup is being created.", +"The backup has been created and is fully usable.", +"The backup is being deleted.", +"The backup is experiencing an issue and might be unusable.", +"The backup is being uploaded." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the instance was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BackupApplianceBackupConfig": { +"description": "BackupApplianceBackupConfig captures the backup configuration for applications that are protected by Backup Appliances.", +"id": "BackupApplianceBackupConfig", +"properties": { +"applicationName": { +"description": "The name of the application.", +"type": "string" +}, +"backupApplianceId": { +"description": "The ID of the backup appliance.", +"format": "int64", +"type": "string" +}, +"backupApplianceName": { +"description": "The name of the backup appliance.", +"type": "string" +}, +"hostName": { +"description": "The name of the host where the application is running.", +"type": "string" +}, +"slaId": { +"description": "The ID of the SLA of this application.", +"format": "int64", +"type": "string" +}, +"slpName": { +"description": "The name of the SLP associated with the application.", +"type": "string" +}, +"sltName": { +"description": "The name of the SLT associated with the application.", +"type": "string" +} +}, +"type": "object" +}, +"BackupApplianceBackupProperties": { +"description": "BackupApplianceBackupProperties represents BackupDR backup appliance's properties.", +"id": "BackupApplianceBackupProperties", +"properties": { +"finalizeTime": { +"description": "Output only. The time when this backup object was finalized (if none, backup is not finalized).", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"generationId": { +"description": "Output only. The numeric generation ID of the backup (monotonically increasing).", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"recoveryRangeEndTime": { +"description": "Optional. The latest timestamp of data available in this Backup.", +"format": "google-datetime", +"type": "string" +}, +"recoveryRangeStartTime": { +"description": "Optional. The earliest timestamp of data available in this Backup.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"BackupApplianceLockInfo": { +"description": "BackupApplianceLockInfo contains metadata about the backupappliance that created the lock.", +"id": "BackupApplianceLockInfo", +"properties": { +"backupApplianceId": { +"description": "Required. The ID of the backup/recovery appliance that created this lock.", +"format": "int64", +"type": "string" +}, +"backupApplianceName": { +"description": "Required. The name of the backup/recovery appliance that created this lock.", +"type": "string" +}, +"backupImage": { +"description": "The image name that depends on this Backup.", +"type": "string" +}, +"jobName": { +"description": "The job name on the backup/recovery appliance that created this lock.", +"type": "string" +}, +"lockReason": { +"description": "Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service.", +"type": "string" +}, +"slaId": { +"description": "The SLA on the backup/recovery appliance that owns the lock.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"BackupConfigDetails": { +"description": "BackupConfigDetails has information about how the resource is configured for backups and about the most recent backup taken for this configuration.", +"id": "BackupConfigDetails", +"properties": { +"applicableResource": { +"description": "Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the resource that is applicable for the backup configuration. Example: \"//compute.googleapis.com/projects/{project}/zones/{zone}/instances/{instance}\"", +"readOnly": true, +"type": "string" +}, +"backupConfigSource": { +"description": "Output only. The full resource name of the backup config source resource. For example, \"//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupPlans/{backupplanId}\" or \"//compute.googleapis.com/projects/{project}/locations/{region}/resourcePolicies/{resourcePolicyId}\".", +"readOnly": true, +"type": "string" +}, +"backupConfigSourceDisplayName": { +"description": "Output only. The display name of the backup config source resource.", +"readOnly": true, +"type": "string" +}, +"backupDrPlanConfig": { +"$ref": "BackupDrPlanConfig", +"description": "Google Cloud Backup and DR's Backup Plan specific data." +}, +"backupDrTemplateConfig": { +"$ref": "BackupDrTemplateConfig", +"description": "Google Cloud Backup and DR's Template specific data." +}, +"backupLocations": { +"description": "The locations where the backups are to be stored.", +"items": { +"$ref": "BackupLocation" +}, +"type": "array" +}, +"backupVault": { +"description": "Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the backup vault that will store the backups generated through this backup configuration. Example: \"//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupVaults/{backupvaultId}\"", +"readOnly": true, +"type": "string" +}, +"latestSuccessfulBackupTime": { +"description": "Output only. Timestamp of the latest successful backup created via this backup configuration.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"pitrSettings": { +"$ref": "PitrSettings", +"description": "Output only. Point in time recovery settings of the backup configuration resource.", +"readOnly": true +}, +"state": { +"description": "Output only. The state of the backup config resource.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"INACTIVE", +"ERROR" +], +"enumDescriptions": [ +"Backup config state not set.", +"The config is in an active state protecting the resource", +"The config is currently not protecting the resource. Either because it is disabled or the owning project has been deleted without cleanup of the actual resource.", +"The config still exists but because of some error state it is not protecting the resource. Like the source project is deleted. For eg. PlanAssociation, BackupPlan is deleted." +], +"readOnly": true, +"type": "string" +}, +"type": { +"description": "Output only. The type of the backup config resource.", +"enum": [ +"TYPE_UNSPECIFIED", +"CLOUD_SQL_INSTANCE_BACKUP_CONFIG", +"COMPUTE_ENGINE_RESOURCE_POLICY", +"BACKUPDR_BACKUP_PLAN", +"BACKUPDR_TEMPLATE" +], +"enumDescriptions": [ +"Backup config type is unspecified.", +"Backup config is Cloud SQL instance's automated backup config.", +"Backup config is Compute Engine Resource Policy.", +"Backup config is Google Cloud Backup and DR's Backup Plan.", +"Backup config is Google Cloud Backup and DR's Template." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BackupConfigInfo": { +"description": "BackupConfigInfo has information about how the resource is configured for Backup and about the most recent backup to this vault.", +"id": "BackupConfigInfo", +"properties": { +"backupApplianceBackupConfig": { +"$ref": "BackupApplianceBackupConfig", +"description": "Configuration for an application backed up by a Backup Appliance." +}, +"gcpBackupConfig": { +"$ref": "GcpBackupConfig", +"description": "Configuration for a Google Cloud resource." +}, +"lastBackupError": { +"$ref": "Status", +"description": "Output only. If the last backup failed, this field has the error message.", +"readOnly": true +}, +"lastBackupState": { +"description": "Output only. The status of the last backup to this BackupVault", +"enum": [ +"LAST_BACKUP_STATE_UNSPECIFIED", +"FIRST_BACKUP_PENDING", +"SUCCEEDED", +"FAILED", +"PERMISSION_DENIED" +], +"enumDescriptions": [ +"Status not set.", +"The first backup has not yet completed", +"The most recent backup was successful", +"The most recent backup failed", +"The most recent backup could not be run/failed because of the lack of permissions" +], +"readOnly": true, +"type": "string" +}, +"lastSuccessfulBackupConsistencyTime": { +"description": "Output only. If the last backup were successful, this field has the consistency date.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BackupDrPlanConfig": { +"description": "BackupDrPlanConfig has additional information about Google Cloud Backup and DR's Plan backup configuration.", +"id": "BackupDrPlanConfig", +"properties": { +"backupDrPlanRules": { +"description": "Backup rules of the backup plan resource.", +"items": { +"$ref": "BackupDrPlanRule" +}, +"type": "array" +} +}, +"type": "object" +}, +"BackupDrPlanRule": { +"description": "BackupDrPlanRule has rule specific information of the backup plan resource.", +"id": "BackupDrPlanRule", +"properties": { +"lastSuccessfulBackupTime": { +"description": "Output only. Timestamp of the latest successful backup created via this backup rule.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"ruleId": { +"description": "Output only. Unique Id of the backup rule.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BackupDrTemplateConfig": { +"description": "Provides additional information about Google Cloud Backup and DR's Template backup configuration.", +"id": "BackupDrTemplateConfig", +"properties": { +"firstPartyManagementUri": { +"description": "Output only. The URI of the BackupDr template resource for the first party identity users.", +"readOnly": true, +"type": "string" +}, +"thirdPartyManagementUri": { +"description": "Output only. The URI of the BackupDr template resource for the third party identity users.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BackupGcpResource": { +"description": "Minimum details to identify a Google Cloud resource for a backup.", +"id": "BackupGcpResource", +"properties": { +"gcpResourcename": { +"description": "Name of the Google Cloud resource.", +"type": "string" +}, +"location": { +"description": "Location of the resource: //\"global\"/\"unspecified\".", +"type": "string" +}, +"type": { +"description": "Type of the resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.", +"type": "string" +} +}, +"type": "object" +}, +"BackupLocation": { +"description": "BackupLocation represents a cloud location where a backup can be stored.", +"id": "BackupLocation", +"properties": { +"locationId": { +"description": "Output only. The id of the cloud location. Example: \"us-central1\"", +"readOnly": true, +"type": "string" +}, +"type": { +"description": "Output only. The type of the location.", +"enum": [ +"TYPE_UNSPECIFIED", +"ZONAL", +"REGIONAL", +"MULTI_REGIONAL" +], +"enumDescriptions": [ +"Location type is unspecified.", +"Location type is zonal.", +"Location type is regional.", +"Location type is multi regional." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BackupLock": { +"description": "BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.", +"id": "BackupLock", +"properties": { +"backupApplianceLockInfo": { +"$ref": "BackupApplianceLockInfo", +"description": "If the client is a backup and recovery appliance, this contains metadata about why the lock exists." +}, +"lockUntilTime": { +"description": "Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion.", +"format": "google-datetime", +"type": "string" +}, +"serviceLockInfo": { +"$ref": "ServiceLockInfo", +"description": "Output only. Contains metadata about the lock exist for Google Cloud native backups.", +"readOnly": true +} +}, +"type": "object" +}, +"BackupPlan": { +"description": "A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads.", +"id": "BackupPlan", +"properties": { +"backupRules": { +"description": "Optional. The backup rules for this `BackupPlan`.", +"items": { +"$ref": "BackupRule" +}, +"type": "array" +}, +"backupVault": { +"description": "Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}", +"type": "string" +}, +"backupVaultServiceAccount": { +"description": "Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.", +"readOnly": true, +"type": "string" +}, +"computeInstanceBackupPlanProperties": { +"$ref": "ComputeInstanceBackupPlanProperties", +"description": "Optional. Defines optional properties specific to backups of compute instance based resources, such as Compute Engine Instances. This includes settings like whether to perform a guest flush." +}, +"createTime": { +"description": "Output only. When the `BackupPlan` was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: \"This is a backup plan that performs a daily backup at 6pm and retains data for 3 months\". The description must be at most 2048 characters.", +"type": "string" +}, +"diskBackupPlanProperties": { +"$ref": "DiskBackupPlanProperties", +"description": "Optional. Defines optional properties specific to backups of disk-based resources, such as Compute Engine Persistent Disks. This includes settings like whether to perform a guest flush." +}, +"etag": { +"description": "Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {\"tag\": \"Weekly\"}.", +"type": "object" +}, +"logRetentionDays": { +"description": "Optional. Applicable only for Cloud SQL resource_type. Configures how long logs will be stored. It is defined in \u201cdays\u201d. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.", +"format": "int64", +"type": "string" +}, +"maxCustomOnDemandRetentionDays": { +"description": "Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.", +"format": "int32", +"type": "integer" +}, +"name": { +"description": "Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`", +"readOnly": true, +"type": "string" +}, +"resourceType": { +"description": "Required. The resource type to which the `BackupPlan` will be applied. Examples include, \"compute.googleapis.com/Instance\", \"sqladmin.googleapis.com/Instance\", \"alloydb.googleapis.com/Cluster\", \"compute.googleapis.com/Disk\".", +"type": "string" +}, +"revisionId": { +"description": "Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.", +"readOnly": true, +"type": "string" +}, +"revisionName": { +"description": "Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The `State` for the `BackupPlan`.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"DELETING", +"INACTIVE", +"UPDATING" +], +"enumDescriptions": [ +"State not set.", +"The resource is being created.", +"The resource has been created and is fully usable.", +"The resource is being deleted.", +"The resource has been created but is not usable.", +"The resource is being updated." +], +"readOnly": true, +"type": "string" +}, +"supportedResourceTypes": { +"description": "Output only. All resource types to which backupPlan can be applied.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"updateTime": { +"description": "Output only. When the `BackupPlan` was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BackupPlanAssociation": { +"description": "A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc", +"id": "BackupPlanAssociation", +"properties": { +"alloydbClusterBackupPlanAssociationProperties": { +"$ref": "AlloyDBClusterBackupPlanAssociationProperties", +"description": "Output only. AlloyDB cluster's backup plan association properties.", +"readOnly": true +}, +"autoProtectionPolicyBinding": { +"description": "Output only. The resource name of the `AutoProtectionPolicyBinding` that manages this association, if any. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}`.", +"readOnly": true, +"type": "string" +}, +"backupPlan": { +"description": "Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}", +"type": "string" +}, +"backupPlanRevisionId": { +"description": "Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.", +"readOnly": true, +"type": "string" +}, +"backupPlanRevisionName": { +"description": "Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`", +"readOnly": true, +"type": "string" +}, +"cloudSqlInstanceBackupPlanAssociationProperties": { +"$ref": "CloudSqlInstanceBackupPlanAssociationProperties", +"description": "Output only. Cloud SQL instance's backup plan association properties.", +"readOnly": true +}, +"createTime": { +"description": "Output only. The time when the instance was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dataSource": { +"description": "Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}", +"readOnly": true, +"type": "string" +}, +"filestoreInstanceBackupPlanAssociationProperties": { +"$ref": "FilestoreInstanceBackupPlanAssociationProperties", +"description": "Output only. Filestore instance's backup plan association properties.", +"readOnly": true +}, +"name": { +"description": "Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}", +"readOnly": true, +"type": "string" +}, +"resource": { +"description": "Required. Immutable. Resource name of workload on which the backup plan is applied. The format can either be the resource name (e.g., \"projects/my-project/zones/us-central1-a/instances/my-instance\") or the full resource URI (e.g., \"https://www.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances/my-instance\").", +"type": "string" +}, +"resourceType": { +"description": "Required. Immutable. Resource type of workload on which backupplan is applied", +"type": "string" +}, +"rulesConfigInfo": { +"description": "Output only. The config info related to backup rules.", +"items": { +"$ref": "RuleConfigInfo" +}, +"readOnly": true, +"type": "array" +}, +"state": { +"description": "Output only. The BackupPlanAssociation resource state.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"DELETING", +"INACTIVE", +"UPDATING" +], +"enumDescriptions": [ +"State not set.", +"The resource is being created.", +"The resource has been created and is fully usable.", +"The resource is being deleted.", +"The resource has been created but is not usable.", +"The resource is being updated." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the instance was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BackupPlanDetail": { +"description": "BackupPlanDetail defines configuration of protection.", +"id": "BackupPlanDetail", +"properties": { +"backupPlan": { +"description": "Required. The resource name of the BackupPlan to apply to resources that match the policy's criteria. This backup plan must be in the same location as AutoProtectionPolicy. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}", +"type": "string" +}, +"resourceType": { +"description": "Required. The type of resource that this policy will automatically protect. For MVP, `compute.googleapis.com/Instance` and `compute.googleapis.com/Disk` are supported.", +"type": "string" +} +}, +"type": "object" +}, +"BackupPlanRevision": { +"description": "`BackupPlanRevision` represents a snapshot of a `BackupPlan` at a point in time.", +"id": "BackupPlanRevision", +"properties": { +"backupPlanSnapshot": { +"$ref": "BackupPlan", +"description": "The Backup Plan being encompassed by this revision." +}, +"createTime": { +"description": "Output only. The timestamp that the revision was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Identifier. The resource name of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision}`", +"readOnly": true, +"type": "string" +}, +"revisionId": { +"description": "Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. Resource State", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"DELETING", +"INACTIVE" +], +"enumDescriptions": [ +"State not set.", +"The resource is being created.", +"The resource has been created and is fully usable.", +"The resource is being deleted.", +"The resource has been created but is not usable." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BackupRule": { +"description": "`BackupRule` binds the backup schedule to a retention policy.", +"id": "BackupRule", +"properties": { +"backupRetentionDays": { +"description": "Required. Configures the duration for which backup data will be kept. It is defined in \u201cdays\u201d. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules. Note: Longer retention can lead to higher storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.", +"format": "int32", +"type": "integer" +}, +"ruleId": { +"description": "Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.", +"type": "string" +}, +"standardSchedule": { +"$ref": "StandardSchedule", +"description": "Optional. Defines a schedule that runs within the confines of a defined window of time." +} +}, +"type": "object" +}, +"BackupVault": { +"description": "Message describing a BackupVault object.", +"id": "BackupVault", +"properties": { +"accessRestriction": { +"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", +"WITHIN_ORGANIZATION", +"UNRESTRICTED", +"WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA" +], +"enumDescriptions": [ +"Access restriction not set. If user does not provide any value or pass this value, it will be changed to WITHIN_ORGANIZATION.", +"Access to or from resources outside your current project will be denied.", +"Access to or from resources outside your current organization will be denied.", +"No access restriction.", +"Access to or from resources outside your current organization will be denied except for backup appliance." +], +"type": "string" +}, +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.", +"type": "object" +}, +"backupCount": { +"description": "Output only. The number of backups in this backup vault.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"backupMinimumEnforcedRetentionDuration": { +"description": "Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. Note: Longer minimum enforced retention period impacts potential storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.", +"format": "google-duration", +"type": "string" +}, +"backupRetentionInheritance": { +"description": "Optional. Setting for how a backup's enforced retention end time is inherited.", +"enum": [ +"BACKUP_RETENTION_INHERITANCE_UNSPECIFIED", +"INHERIT_VAULT_RETENTION", +"MATCH_BACKUP_EXPIRE_TIME" +], +"enumDescriptions": [ +"Inheritance behavior not set. This will default to `INHERIT_VAULT_RETENTION`.", +"The enforced retention end time of a backup will be inherited from the backup vault's `backup_minimum_enforced_retention_duration` field. This is the default behavior.", +"The enforced retention end time of a backup will always match the expire time of the backup. If this is set, the backup's enforced retention end time will be set to match the expire time during creation of the backup. When updating, the ERET and expire time must be updated together and have the same value. Invalid update requests will be rejected by the server." +], +"type": "string" +}, +"createTime": { +"description": "Output only. The time when the instance was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"deletable": { +"description": "Output only. Set to true when there are no backups nested under this resource.", +"readOnly": true, +"type": "boolean" +}, +"description": { +"description": "Optional. The description of the BackupVault instance (2048 characters or less).", +"type": "string" +}, +"effectiveTime": { +"description": "Optional. Time after which the BackupVault resource is locked.", +"format": "google-datetime", +"type": "string" +}, +"encryptionConfig": { +"$ref": "EncryptionConfig", +"description": "Optional. The encryption config of the backup vault." +}, +"etag": { +"description": "Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Resource labels to represent user provided metadata. No labels currently defined:", +"type": "object" +}, +"name": { +"description": "Output only. Identifier. Name of the backup vault to create. It must have the format`\"projects/{project}/locations/{location}/backupVaults/{backupvault}\"`. `{backupvault}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.", +"readOnly": true, +"type": "string" +}, +"serviceAccount": { +"description": "Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The BackupVault resource instance state.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"DELETING", +"ERROR", +"UPDATING" +], +"enumDescriptions": [ +"State not set.", +"The backup vault is being created.", +"The backup vault has been created and is fully usable.", +"The backup vault is being deleted.", +"The backup vault is experiencing an issue and might be unusable.", +"The backup vault is being updated." +], +"readOnly": true, +"type": "string" +}, +"totalStoredBytes": { +"description": "Output only. Total size of the storage used by all backup resources.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"uid": { +"description": "Output only. Immutable after resource creation until resource deletion.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the instance was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BackupWindow": { +"description": "`BackupWindow` defines a window of the day during which backup jobs will run.", +"id": "BackupWindow", +"properties": { +"endHourOfDay": { +"description": "Required. The hour of day (1-24) when the window end for e.g. if value of end hour of day is 10 that mean backup window end time is 10:00. End hour of day should be greater than start hour of day. 0 <= start_hour_of_day < end_hour_of_day <= 24 End hour of day is not include in backup window that mean if end_hour_of_day= 10 jobs should start before 10:00.", +"format": "int32", +"type": "integer" +}, +"startHourOfDay": { +"description": "Required. The hour of day (0-23) when the window starts for e.g. if value of start hour of day is 6 that mean backup window start at 6:00.", +"format": "int32", +"type": "integer" +} +}, +"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" +}, +"BindingEvaluationSummary": { +"description": "BindingEvaluationSummary contains the summary of the last run of job that applies policy to matching resources for a given binding.", +"id": "BindingEvaluationSummary", +"properties": { +"failedResourceCount": { +"description": "Output only. The number of matching resources whose protection failed during job run.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"matchingResourceCount": { +"description": "Output only. The number of resources that currently match the policy's criteria.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"protectedResourceCount": { +"description": "Output only. The number of matching resources that are successfully protected.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BindingMatchingResource": { +"description": "BindingMatchingResource contains the details of a resource that matches the criteria of a binding.", +"id": "BindingMatchingResource", +"properties": { +"autoProtectionDetails": { +"$ref": "AutoProtectionDetails", +"description": "Output only. The auto protection details of the resource from the current binding's perspective.", +"readOnly": true +}, +"lastEvaluationTime": { +"description": "Output only. The timestamp when the resource was last evaluated for protection.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the `BindingMatchingResource`. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}`", +"type": "string" +}, +"resource": { +"description": "Required. Immutable. Resource name of the workload that matches the criteria of the binding. The format can be either a relative resource name (e.g., `projects/my-project/zones/us-central1-a/instances/my-instance`) or a schemeless full resource name (e.g., `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`).", +"type": "string" +} +}, +"type": "object" +}, +"BindingSummary": { +"description": "BindingSummary contains count of different containers covered through this policy.", +"id": "BindingSummary", +"properties": { +"projectCount": { +"description": "Output only. Total count of Projects protected with this policy.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CancelOperationRequest": { +"description": "The request message for Operations.CancelOperation.", +"id": "CancelOperationRequest", +"properties": {}, +"type": "object" +}, +"CloudSqlInstanceBackupPlanAssociationProperties": { +"description": "Cloud SQL instance's BPA properties.", +"id": "CloudSqlInstanceBackupPlanAssociationProperties", +"properties": { +"instanceCreateTime": { +"description": "Output only. The time when the instance was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CloudSqlInstanceBackupProperties": { +"description": "CloudSqlInstanceBackupProperties represents Cloud SQL Instance Backup properties.", +"id": "CloudSqlInstanceBackupProperties", +"properties": { +"databaseInstalledVersion": { +"description": "Output only. The installed database version of the Cloud SQL instance when the backup was taken.", +"readOnly": true, +"type": "string" +}, +"finalBackup": { +"description": "Output only. Whether the backup is a final backup.", +"readOnly": true, +"type": "boolean" +}, +"instanceCreateTime": { +"description": "Output only. The instance creation timestamp.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"instanceDeleteTime": { +"description": "Output only. The instance delete timestamp.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"instanceTier": { +"description": "Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`", +"readOnly": true, +"type": "string" +}, +"sourceInstance": { +"description": "Output only. The source instance of the backup. Format: projects/{project}/instances/{instance}", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CloudSqlInstanceDataSourceProperties": { +"description": "CloudSqlInstanceDataSourceProperties represents the properties of a Cloud SQL resource that are stored in the DataSource.", +"id": "CloudSqlInstanceDataSourceProperties", +"properties": { +"databaseInstalledVersion": { +"description": "Output only. The installed database version of the Cloud SQL instance.", +"readOnly": true, +"type": "string" +}, +"instanceCreateTime": { +"description": "Output only. The instance creation timestamp.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"instanceTier": { +"description": "Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance}", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CloudSqlInstanceDataSourceReferenceProperties": { +"description": "CloudSqlInstanceDataSourceReferenceProperties represents the properties of a Cloud SQL resource that are stored in the DataSourceReference.", +"id": "CloudSqlInstanceDataSourceReferenceProperties", +"properties": { +"databaseInstalledVersion": { +"description": "Output only. The installed database version of the Cloud SQL instance.", +"readOnly": true, +"type": "string" +}, +"instanceCreateTime": { +"description": "Output only. The instance creation timestamp.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"instanceTier": { +"description": "Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance}", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CloudSqlInstanceInitializationConfig": { +"description": "CloudSqlInstanceInitializationConfig contains the configuration for initializing a Cloud SQL instance.", +"id": "CloudSqlInstanceInitializationConfig", +"properties": { +"edition": { +"description": "Required. The edition of the Cloud SQL instance.", +"enum": [ +"EDITION_UNSPECIFIED", +"ENTERPRISE", +"ENTERPRISE_PLUS" +], +"enumDescriptions": [ +"Unspecified edition.", +"Enterprise edition.", +"Enterprise Plus edition." +], +"type": "string" +} +}, +"type": "object" +}, +"ComputeInstanceBackupPlanProperties": { +"description": "Properties for a compute instance backup plan.", +"id": "ComputeInstanceBackupPlanProperties", +"properties": { +"guestFlush": { +"description": "Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false.", +"type": "boolean" +} +}, +"type": "object" +}, +"ComputeInstanceBackupProperties": { +"description": "ComputeInstanceBackupProperties represents Compute Engine instance backup properties.", +"id": "ComputeInstanceBackupProperties", +"properties": { +"canIpForward": { +"description": "Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify `true`. If unsure, leave this set to `false`. See the https://cloud.google.com/vpc/docs/using-routes#canipforward documentation for more information.", +"type": "boolean" +}, +"description": { +"description": "An optional text description for the instances that are created from these properties.", +"type": "string" +}, +"disk": { +"description": "An array of disks that are associated with the instances that are created from these properties.", +"items": { +"$ref": "AttachedDisk" +}, +"type": "array" +}, +"guestAccelerator": { +"description": "A list of guest accelerator cards' type and count to use for instances created from these properties.", +"items": { +"$ref": "AcceleratorConfig" +}, +"type": "array" +}, +"guestFlush": { +"description": "Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false.", +"type": "boolean" +}, +"keyRevocationActionType": { +"description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.", +"enum": [ +"KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", +"NONE", +"STOP" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Indicates user chose no operation.", +"Indicates user chose to opt for VM shutdown on key revocation." +], +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Labels to apply to instances that are created from these properties.", +"type": "object" +}, +"machineType": { +"description": "The machine type to use for instances that are created from these properties.", +"type": "string" +}, +"metadata": { +"$ref": "Metadata", +"description": "The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information." +}, +"minCpuPlatform": { +"description": "Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: Intel Haswell` or `minCpuPlatform: Intel Sandy Bridge`. For more information, read https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.", +"type": "string" +}, +"networkInterface": { +"description": "An array of network access configurations for this interface.", +"items": { +"$ref": "NetworkInterface" +}, +"type": "array" +}, +"scheduling": { +"$ref": "Scheduling", +"description": "Specifies the scheduling options for the instances that are created from these properties." +}, +"serviceAccount": { +"description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.", +"items": { +"$ref": "ServiceAccount" +}, +"type": "array" +}, +"sourceInstance": { +"description": "The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance", +"type": "string" +}, +"tags": { +"$ref": "Tags", +"description": "A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt)." +} +}, +"type": "object" +}, +"ComputeInstanceDataSourceProperties": { +"description": "ComputeInstanceDataSourceProperties represents the properties of a ComputeEngine resource that are stored in the DataSource.", +"id": "ComputeInstanceDataSourceProperties", +"properties": { +"description": { +"description": "The description of the Compute Engine instance.", +"type": "string" +}, +"machineType": { +"description": "The machine type of the instance.", +"type": "string" +}, +"name": { +"description": "Name of the compute instance backed up by the datasource.", +"type": "string" +}, +"totalDiskCount": { +"description": "The total number of disks attached to the Instance.", +"format": "int64", +"type": "string" +}, +"totalDiskSizeGb": { +"description": "The sum of all the disk sizes.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"ComputeInstanceRestoreProperties": { +"description": "ComputeInstanceRestoreProperties represents Compute Engine instance properties to be overridden during restore.", +"id": "ComputeInstanceRestoreProperties", +"properties": { +"advancedMachineFeatures": { +"$ref": "AdvancedMachineFeatures", +"description": "Optional. Controls for advanced machine-related behavior features." +}, +"canIpForward": { +"description": "Optional. Allows this instance to send and receive packets with non-matching destination or source IPs.", +"type": "boolean" +}, +"confidentialInstanceConfig": { +"$ref": "ConfidentialInstanceConfig", +"description": "Optional. Controls Confidential compute options on the instance" +}, +"deletionProtection": { +"description": "Optional. Whether the resource should be protected against deletion.", +"type": "boolean" +}, +"description": { +"description": "Optional. An optional description of this resource. Provide this property when you create the resource.", +"type": "string" +}, +"disks": { +"description": "Optional. Array of disks associated with this instance. Persistent disks must be created before you can assign them. Source regional persistent disks will be restored with default replica zones if not specified.", +"items": { +"$ref": "AttachedDisk" +}, +"type": "array" +}, +"displayDevice": { +"$ref": "DisplayDevice", +"description": "Optional. Enables display device for the instance." +}, +"guestAccelerators": { +"description": "Optional. A list of the type and count of accelerator cards attached to the instance.", +"items": { +"$ref": "AcceleratorConfig" +}, +"type": "array" +}, +"hostname": { +"description": "Optional. Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.", +"type": "string" +}, +"instanceEncryptionKey": { +"$ref": "CustomerEncryptionKey", +"description": "Optional. Encrypts suspended data for an instance with a customer-managed encryption key." +}, +"keyRevocationActionType": { +"description": "Optional. KeyRevocationActionType of the instance.", +"enum": [ +"KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", +"NONE", +"STOP" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Indicates user chose no operation.", +"Indicates user chose to opt for VM shutdown on key revocation." +], +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels to apply to this instance.", +"type": "object" +}, +"machineType": { +"description": "Optional. Full or partial URL of the machine type resource to use for this instance.", +"type": "string" +}, +"metadata": { +"$ref": "Metadata", +"description": "Optional. This includes custom metadata and predefined keys." +}, +"minCpuPlatform": { +"description": "Optional. Minimum CPU platform to use for this instance.", +"type": "string" +}, +"name": { +"description": "Required. Name of the compute instance.", +"type": "string" +}, +"networkInterfaces": { +"description": "Optional. An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. Required to restore in different project or region.", +"items": { +"$ref": "NetworkInterface" +}, +"type": "array" +}, +"networkPerformanceConfig": { +"$ref": "NetworkPerformanceConfig", +"description": "Optional. Configure network performance such as egress bandwidth tier." +}, +"params": { +"$ref": "InstanceParams", +"description": "Input only. Additional params passed with the request, but not persisted as part of resource payload." +}, +"privateIpv6GoogleAccess": { +"description": "Optional. The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.", +"enum": [ +"INSTANCE_PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED", +"INHERIT_FROM_SUBNETWORK", +"ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE", +"ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.", +"Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.", +"Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before." +], +"type": "string" +}, +"reservationAffinity": { +"$ref": "AllocationAffinity", +"description": "Optional. Specifies the reservations that this instance can consume from." +}, +"resourcePolicies": { +"description": "Optional. Resource policies applied to this instance. By default, no resource policies will be applied.", +"items": { +"type": "string" +}, +"type": "array" +}, +"scheduling": { +"$ref": "Scheduling", +"description": "Optional. Sets the scheduling options for this instance." +}, +"serviceAccounts": { +"description": "Optional. A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.", +"items": { +"$ref": "ServiceAccount" +}, +"type": "array" +}, +"tags": { +"$ref": "Tags", +"description": "Optional. Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation." +} +}, +"type": "object" +}, +"ComputeInstanceTargetEnvironment": { +"description": "ComputeInstanceTargetEnvironment represents Compute Engine target environment to be used during restore.", +"id": "ComputeInstanceTargetEnvironment", +"properties": { +"project": { +"description": "Required. Target project for the Compute Engine instance.", +"type": "string" +}, +"useProjectServiceAccount": { +"description": "Optional. Whether to use the project service account for the Compute Engine instance restore.", +"type": "boolean" +}, +"zone": { +"description": "Required. The zone of the Compute Engine instance.", +"type": "string" +} +}, +"type": "object" +}, +"ConfidentialInstanceConfig": { +"description": "A set of Confidential Instance options.", +"id": "ConfidentialInstanceConfig", +"properties": { +"enableConfidentialCompute": { +"description": "Optional. Defines whether the instance should have confidential compute enabled.", +"type": "boolean" +} +}, +"type": "object" +}, +"Criteria": { +"description": "Criteria specifies a set of criteria for matching resources.", +"id": "Criteria", +"properties": { +"matchingConditions": { +"description": "Required. A list of matching conditions that a resource must meet to be protected by the policy.", +"items": { +"$ref": "MatchingCondition" +}, +"type": "array" +} +}, +"type": "object" +}, +"CustomerEncryptionKey": { +"description": "A customer-supplied encryption key.", +"id": "CustomerEncryptionKey", +"properties": { +"kmsKeyName": { +"description": "Optional. The name of the encryption key that is stored in Google Cloud KMS.", +"type": "string" +}, +"kmsKeyServiceAccount": { +"description": "Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.", +"type": "string" +}, +"rawKey": { +"description": "Optional. Specifies a 256-bit customer-supplied encryption key.", +"type": "string" +}, +"rsaEncryptedKey": { +"description": "Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.", +"type": "string" +} +}, +"type": "object" +}, +"DataSource": { +"description": "Message describing a DataSource object. Datasource object used to represent Datasource details for both admin and basic view.", +"id": "DataSource", +"properties": { +"backupBlockedByVaultAccessRestriction": { +"description": "Output only. This field is set to true if the backup is blocked by vault access restriction.", +"readOnly": true, +"type": "boolean" +}, +"backupConfigInfo": { +"$ref": "BackupConfigInfo", +"description": "Output only. Details of how the resource is configured for backup.", +"readOnly": true +}, +"backupCount": { +"description": "Number of backups in the data source.", +"format": "int64", +"type": "string" +}, +"configState": { +"description": "Output only. The backup configuration state.", +"enum": [ +"BACKUP_CONFIG_STATE_UNSPECIFIED", +"ACTIVE", +"PASSIVE" +], +"enumDescriptions": [ +"The possible states of backup configuration. Status not set.", +"The data source is actively protected (i.e. there is a BackupPlanAssociation or Appliance SLA pointing to it)", +"The data source is no longer protected (but may have backups under it)" +], +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time when the instance was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dataSourceBackupApplianceApplication": { +"$ref": "DataSourceBackupApplianceApplication", +"description": "The backed up resource is a backup appliance application." +}, +"dataSourceGcpResource": { +"$ref": "DataSourceGcpResource", +"description": "The backed up resource is a Google Cloud resource. The word 'DataSource' was included in the names to indicate that this is the representation of the Google Cloud resource used within the DataSource object." +}, +"etag": { +"description": "Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Resource labels to represent user provided metadata. No labels currently defined:", +"type": "object" +}, +"name": { +"description": "Output only. Identifier. Name of the datasource to create. It must have the format`\"projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}\"`. `{datasource}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the backup vault.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The DataSource resource instance state.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"ACTIVE", +"DELETING", +"ERROR" +], +"enumDescriptions": [ +"State not set.", +"The data source is being created.", +"The data source has been created and is fully usable.", +"The data source is being deleted.", +"The data source is experiencing an issue and might be unusable." +], +"readOnly": true, +"type": "string" +}, +"totalStoredBytes": { +"description": "The number of bytes (metadata and data) stored in this datasource.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the instance was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"DataSourceBackupApplianceApplication": { +"description": "BackupApplianceApplication describes a Source Resource when it is an application backed up by a BackupAppliance.", +"id": "DataSourceBackupApplianceApplication", +"properties": { +"applianceId": { +"description": "Appliance Id of the Backup Appliance.", +"format": "int64", +"type": "string" +}, +"applicationId": { +"description": "The appid field of the application within the Backup Appliance.", +"format": "int64", +"type": "string" +}, +"applicationName": { +"description": "The name of the Application as known to the Backup Appliance.", +"type": "string" +}, +"backupAppliance": { +"description": "Appliance name.", +"type": "string" +}, +"hostId": { +"description": "Hostid of the application host.", +"format": "int64", +"type": "string" +}, +"hostname": { +"description": "Hostname of the host where the application is running.", +"type": "string" +}, +"type": { +"description": "The type of the application. e.g. VMBackup", +"type": "string" +} +}, +"type": "object" +}, +"DataSourceBackupConfigInfo": { +"description": "Information of backup configuration on the DataSource.", +"id": "DataSourceBackupConfigInfo", +"properties": { +"lastBackupState": { +"description": "Output only. The status of the last backup in this DataSource", +"enum": [ +"LAST_BACKUP_STATE_UNSPECIFIED", +"FIRST_BACKUP_PENDING", +"SUCCEEDED", +"FAILED", +"PERMISSION_DENIED" +], +"enumDescriptions": [ +"Status not set.", +"The first backup has not yet completed", +"The most recent backup was successful", +"The most recent backup failed", +"The most recent backup could not be run/failed because of the lack of permissions" +], +"readOnly": true, +"type": "string" +}, +"lastSuccessfulBackupConsistencyTime": { +"description": "Output only. Timestamp of the last successful backup to this DataSource.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"DataSourceGcpResource": { +"description": "DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource", +"id": "DataSourceGcpResource", +"properties": { +"alloyDbClusterDatasourceProperties": { +"$ref": "AlloyDBClusterDataSourceProperties", +"description": "Output only. AlloyDBClusterDataSourceProperties has a subset of AlloyDB cluster properties that are useful at the Datasource level. Currently none of its child properties are auditable. If new auditable properties are added, the AUDIT annotation should be added.", +"readOnly": true +}, +"cloudSqlInstanceDatasourceProperties": { +"$ref": "CloudSqlInstanceDataSourceProperties", +"description": "Output only. CloudSqlInstanceDataSourceProperties has a subset of Cloud SQL Instance properties that are useful at the Datasource level.", +"readOnly": true +}, +"computeInstanceDatasourceProperties": { +"$ref": "ComputeInstanceDataSourceProperties", +"description": "ComputeInstanceDataSourceProperties has a subset of Compute Instance properties that are useful at the Datasource level." +}, +"diskDatasourceProperties": { +"$ref": "DiskDataSourceProperties", +"description": "DiskDataSourceProperties has a subset of Disk properties that are useful at the Datasource level." +}, +"filestoreInstanceDatasourceProperties": { +"$ref": "FilestoreInstanceDataSourceProperties", +"description": "Output only. FilestoreInstanceDataSourceProperties has a subset of FileStore instance properties that are useful at the Datasource level.", +"readOnly": true +}, +"gcpResourcename": { +"description": "Output only. Full resource pathname URL of the source Google Cloud resource.", +"readOnly": true, +"type": "string" +}, +"location": { +"description": "Location of the resource: //\"global\"/\"unspecified\".", +"type": "string" +}, +"type": { +"description": "The type of the Google Cloud resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.", +"type": "string" +} +}, +"type": "object" +}, +"DataSourceGcpResourceInfo": { +"description": "The Google Cloud resource that the DataSource is associated with.", +"id": "DataSourceGcpResourceInfo", +"properties": { +"alloyDbClusterProperties": { +"$ref": "AlloyDBClusterDataSourceReferenceProperties", +"description": "Output only. The properties of the AlloyDB cluster.", +"readOnly": true +}, +"cloudSqlInstanceProperties": { +"$ref": "CloudSqlInstanceDataSourceReferenceProperties", +"description": "Output only. The properties of the Cloud SQL instance.", +"readOnly": true +}, +"filestoreInstanceProperties": { +"$ref": "FilestoreInstanceDataSourceReferenceProperties", +"description": "Output only. The properties of the Filestore instance.", +"readOnly": true +}, +"gcpResourcename": { +"description": "Output only. The resource name of the Google Cloud resource. Ex: projects/{project}/zones/{zone}/instances/{instance}", +"readOnly": true, +"type": "string" +}, +"location": { +"description": "Output only. The location of the Google Cloud resource. Ex: //\"global\"/\"unspecified\"", +"readOnly": true, +"type": "string" +}, +"type": { +"description": "Output only. The type of the Google Cloud resource. Ex: compute.googleapis.com/Instance", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"DataSourceReference": { +"description": "DataSourceReference is a reference to a DataSource resource.", +"id": "DataSourceReference", +"properties": { +"createTime": { +"description": "Output only. The time when the DataSourceReference was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dataSource": { +"description": "Output only. The resource name of the DataSource. Format: projects/{project}/locations/{location}/backupVaults/{backupVault}/dataSources/{dataSource}", +"readOnly": true, +"type": "string" +}, +"dataSourceBackupConfigInfo": { +"$ref": "DataSourceBackupConfigInfo", +"description": "Output only. Information of backup configuration on the DataSource.", +"readOnly": true +}, +"dataSourceBackupConfigState": { +"description": "Output only. The backup configuration state of the DataSource.", +"enum": [ +"BACKUP_CONFIG_STATE_UNSPECIFIED", +"ACTIVE", +"PASSIVE" +], +"enumDescriptions": [ +"The possible states of backup configuration. Status not set.", +"The data source is actively protected (i.e. there is a BackupPlanAssociation or Appliance SLA pointing to it)", +"The data source is no longer protected (but may have backups under it)" +], +"readOnly": true, +"type": "string" +}, +"dataSourceBackupCount": { +"description": "Output only. Number of backups in the DataSource.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"dataSourceGcpResourceInfo": { +"$ref": "DataSourceGcpResourceInfo", +"description": "Output only. The Google Cloud resource that the DataSource is associated with.", +"readOnly": true +}, +"name": { +"description": "Identifier. The resource name of the DataSourceReference. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}", +"type": "string" +}, +"totalStoredBytes": { +"description": "Output only. Total size of the storage used by all backup resources for the referenced datasource.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"DiskBackupPlanProperties": { +"description": "Properties for a disk backup plan.", +"id": "DiskBackupPlanProperties", +"properties": { +"guestFlush": { +"description": "Optional. Indicates whether to perform a guest flush operation before taking a disk backup. When set to false, the system will create crash-consistent backups. Default value is false.", +"type": "boolean" +} +}, +"type": "object" +}, +"DiskBackupProperties": { +"description": "DiskBackupProperties represents the properties of a Disk backup.", +"id": "DiskBackupProperties", +"properties": { +"accessMode": { +"description": "The access mode of the source disk.", +"type": "string" +}, +"architecture": { +"description": "The architecture of the source disk. Valid values are ARM64 or X86_64.", +"enum": [ +"ARCHITECTURE_UNSPECIFIED", +"X86_64", +"ARM64" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Disks with architecture X86_64", +"Disks with architecture ARM64" +], +"type": "string" +}, +"description": { +"description": "A description of the source disk.", +"type": "string" +}, +"enableConfidentialCompute": { +"description": "Indicates whether the source disk is using confidential compute mode.", +"type": "boolean" +}, +"guestFlush": { +"description": "Optional. Defines if the guest flush is enabled for the source disk. Default value is false.", +"type": "boolean" +}, +"guestOsFeature": { +"description": "A list of guest OS features that are applicable to this backup.", +"items": { +"$ref": "GuestOsFeature" +}, +"type": "array" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "The labels of the source disk.", +"type": "object" +}, +"licenses": { +"description": "A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image.", +"items": { +"type": "string" +}, +"type": "array" +}, +"physicalBlockSizeBytes": { +"description": "The physical block size of the source disk.", +"format": "int64", +"type": "string" +}, +"provisionedIops": { +"description": "The number of IOPS provisioned for the source disk.", +"format": "int64", +"type": "string" +}, +"provisionedThroughput": { +"description": "The number of throughput provisioned for the source disk.", +"format": "int64", +"type": "string" +}, +"region": { +"description": "Region and zone are mutually exclusive fields. The URL of the region of the source disk.", +"type": "string" +}, +"replicaZones": { +"description": "The URL of the Zones where the source disk should be replicated.", +"items": { +"type": "string" +}, +"type": "array" +}, +"sizeGb": { +"description": "Size(in GB) of the source disk.", +"format": "int64", +"type": "string" +}, +"sourceDisk": { +"description": "The source disk used to create this backup.", +"type": "string" +}, +"storagePool": { +"description": "The storage pool of the source disk.", +"type": "string" +}, +"type": { +"description": "The URL of the type of the disk.", +"type": "string" +}, +"zone": { +"description": "The URL of the Zone where the source disk.", +"type": "string" +} +}, +"type": "object" +}, +"DiskDataSourceProperties": { +"description": "DiskDataSourceProperties represents the properties of a Disk resource that are stored in the DataSource. .", +"id": "DiskDataSourceProperties", +"properties": { +"description": { +"description": "The description of the disk.", +"type": "string" +}, +"name": { +"description": "Name of the disk backed up by the datasource.", +"type": "string" +}, +"sizeGb": { +"description": "The size of the disk in GB.", +"format": "int64", +"type": "string" +}, +"type": { +"description": "The type of the disk.", +"type": "string" +} +}, +"type": "object" +}, +"DiskRestoreProperties": { +"description": "DiskRestoreProperties represents the properties of a Disk restore.", +"id": "DiskRestoreProperties", +"properties": { +"accessMode": { +"description": "Optional. The access mode of the disk.", +"enum": [ +"READ_WRITE_SINGLE", +"READ_WRITE_MANY", +"READ_ONLY_MANY" +], +"enumDescriptions": [ +"The default AccessMode, means the disk can be attached to single instance in RW mode.", +"The AccessMode means the disk can be attached to multiple instances in RW mode.", +"The AccessMode means the disk can be attached to multiple instances in RO mode." +], +"type": "string" +}, +"architecture": { +"description": "Optional. The architecture of the source disk. Valid values are ARM64 or X86_64.", +"enum": [ +"ARCHITECTURE_UNSPECIFIED", +"X86_64", +"ARM64" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Disks with architecture X86_64", +"Disks with architecture ARM64" +], +"type": "string" +}, +"description": { +"description": "Optional. An optional description of this resource. Provide this property when you create the resource.", +"type": "string" +}, +"diskEncryptionKey": { +"$ref": "CustomerEncryptionKey", +"description": "Optional. Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key." +}, +"enableConfidentialCompute": { +"description": "Optional. Indicates whether this disk is using confidential compute mode. Encryption with a Cloud KMS key is required to enable this option.", +"type": "boolean" +}, +"guestOsFeature": { +"description": "Optional. A list of features to enable in the guest operating system. This is applicable only for bootable images.", +"items": { +"$ref": "GuestOsFeature" +}, +"type": "array" +}, +"instanceBackupSource": { +"$ref": "RestoreDiskFromInstanceOptions", +"description": "Options for creating a disk from a source Compute Instance backup." +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels to apply to this disk. These can be modified later using setLabels method. Label values can be empty.", +"type": "object" +}, +"licenses": { +"description": "Optional. A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image", +"items": { +"type": "string" +}, +"type": "array" +}, +"name": { +"description": "Required. Name of the disk.", +"type": "string" +}, +"physicalBlockSizeBytes": { +"description": "Optional. Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently, the supported size is 4096.", +"format": "int64", +"type": "string" +}, +"provisionedIops": { +"description": "Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle.", +"format": "int64", +"type": "string" +}, +"provisionedThroughput": { +"description": "Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle.", +"format": "int64", +"type": "string" +}, +"resourceManagerTags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Resource manager tags to be bound to the disk.", +"type": "object" +}, +"resourcePolicy": { +"description": "Optional. Resource policies applied to this disk.", +"items": { +"type": "string" +}, +"type": "array" +}, +"sizeGb": { +"description": "Required. The size of the disk in GB.", +"format": "int64", +"type": "string" +}, +"storagePool": { +"description": "Optional. The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource.", +"type": "string" +}, +"type": { +"description": "Required. URL of the disk type resource describing which disk type to use to create the disk.", +"type": "string" +} +}, +"type": "object" +}, +"DiskTargetEnvironment": { +"description": "DiskTargetEnvironment represents the target environment for the disk.", +"id": "DiskTargetEnvironment", +"properties": { +"project": { +"description": "Required. Target project for the disk.", +"type": "string" +}, +"useProjectServiceAccount": { +"description": "Optional. Whether to use the project service account for the disk restore.", +"type": "boolean" +}, +"zone": { +"description": "Required. Target zone for the disk.", +"type": "string" +} +}, +"type": "object" +}, +"DisplayDevice": { +"description": "A set of Display Device options", +"id": "DisplayDevice", +"properties": { +"enableDisplay": { +"description": "Optional. Enables display for the Compute Engine VM", +"type": "boolean" +} +}, +"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" +}, +"EncryptionConfig": { +"description": "Message describing the EncryptionConfig of backup vault. This determines how data within the vault is encrypted at rest.", +"id": "EncryptionConfig", +"properties": { +"kmsKeyName": { +"description": "Optional. The Cloud KMS key name to encrypt backups in this backup vault. Must be in the same region as the vault. Some workload backups like compute disk backups may use their inherited source key instead. Format: projects/{project}/locations/{location}/keyRings/{ring}/cryptoKeys/{key}", +"type": "string" +} +}, +"type": "object" +}, +"EndTrialRequest": { +"description": "Request message for ending a trial.", +"id": "EndTrialRequest", +"properties": { +"endReason": { +"description": "Required. The reason for ending the trial.", +"enum": [ +"END_REASON_UNSPECIFIED", +"MOVE_TO_PAID", +"DISCONTINUED" +], +"enumDescriptions": [ +"End reason not set.", +"Trial is deliberately ended by the user to transition to paid usage.", +"Trial is discontinued before expiration." +], +"type": "string" +} +}, +"type": "object" +}, +"Entry": { +"description": "A key/value pair to be used for storing metadata.", +"id": "Entry", +"properties": { +"key": { +"description": "Optional. Key for the metadata entry.", +"type": "string" +}, +"value": { +"description": "Optional. Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).", +"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" +}, +"FetchAccessTokenRequest": { +"description": "Request message for FetchAccessToken.", +"id": "FetchAccessTokenRequest", +"properties": { +"generationId": { +"description": "Required. The generation of the backup to update.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"FetchAccessTokenResponse": { +"description": "Response message for FetchAccessToken.", +"id": "FetchAccessTokenResponse", +"properties": { +"expireTime": { +"description": "The token is valid until this time.", +"format": "google-datetime", +"type": "string" +}, +"readLocation": { +"description": "The location in bucket that can be used for reading.", +"type": "string" +}, +"token": { +"description": "Input only. The downscoped token that was created.", +"type": "string" +}, +"writeLocation": { +"description": "The location in bucket that can be used for writing.", +"type": "string" +} +}, +"type": "object" +}, +"FetchBackupPlanAssociationsForResourceTypeResponse": { +"description": "Response for the FetchBackupPlanAssociationsForResourceType method.", +"id": "FetchBackupPlanAssociationsForResourceTypeResponse", +"properties": { +"backupPlanAssociations": { +"description": "Output only. The BackupPlanAssociations from the specified parent.", +"items": { +"$ref": "BackupPlanAssociation" +}, +"readOnly": true, +"type": "array" +}, +"nextPageToken": { +"description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"FetchBackupsForResourceTypeResponse": { +"description": "Response for the FetchBackupsForResourceType method.", +"id": "FetchBackupsForResourceTypeResponse", +"properties": { +"backups": { +"description": "The Backups from the specified parent.", +"items": { +"$ref": "Backup" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"FetchDataSourceReferencesForResourceTypeResponse": { +"description": "Response for the FetchDataSourceReferencesForResourceType method.", +"id": "FetchDataSourceReferencesForResourceTypeResponse", +"properties": { +"dataSourceReferences": { +"description": "The DataSourceReferences from the specified parent.", +"items": { +"$ref": "DataSourceReference" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"FetchMsComplianceMetadataRequest": { +"description": "Request message for GetMsComplianceMetadata", +"id": "FetchMsComplianceMetadataRequest", +"properties": { +"projectId": { +"description": "Required. The project id of the target project", +"type": "string" +} +}, +"type": "object" +}, +"FetchMsComplianceMetadataResponse": { +"description": "Response message for GetMsComplianceMetadata", +"id": "FetchMsComplianceMetadataResponse", +"properties": { +"isAssuredWorkload": { +"description": "The ms compliance metadata of the target project, if the project is an Assured Workloads project, values will be true, otherwise false.", +"type": "boolean" +} +}, +"type": "object" +}, +"FetchResourceBackupConfigsResponse": { +"description": "Response for FetchResourceBackupConfigs.", +"id": "FetchResourceBackupConfigsResponse", +"properties": { +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"resourceBackupConfigs": { +"description": "The list of ResourceBackupConfigs for the specified scope.", +"items": { +"$ref": "ResourceBackupConfig" +}, +"type": "array" +} +}, +"type": "object" +}, +"FetchUsableBackupVaultsResponse": { +"description": "Response message for fetching usable BackupVaults.", +"id": "FetchUsableBackupVaultsResponse", +"properties": { +"backupVaults": { +"description": "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.", +"items": { +"$ref": "BackupVault" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"FilestoreInstanceBackupPlanAssociationProperties": { +"description": "Filestore instance's BPA properties.", +"id": "FilestoreInstanceBackupPlanAssociationProperties", +"properties": { +"instanceCreateTime": { +"description": "Output only. The time when the instance was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"FilestoreInstanceBackupProperties": { +"description": "FilestoreInstanceBackupProperties represents the properties of a Filestore instance that are backed up by the datasource. .", +"id": "FilestoreInstanceBackupProperties", +"properties": { +"sourceInstance": { +"description": "Output only. The source instance of the backup.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"FilestoreInstanceDataSourceProperties": { +"description": "FilestoreInstanceDataSourceProperties represents the properties of a Filestore resource that are stored in the DataSource. .", +"id": "FilestoreInstanceDataSourceProperties", +"properties": { +"instanceCreateTime": { +"description": "Output only. The instance creation timestamp.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Name of the Filestore instance backed up by the datasource.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"FilestoreInstanceDataSourceReferenceProperties": { +"description": "FilestoreInstanceDataSourceReferenceProperties represents the properties of a Filestore resource that are stored in the DataSourceReference. .", +"id": "FilestoreInstanceDataSourceReferenceProperties", +"properties": { +"instanceCreateTime": { +"description": "Output only. The instance creation timestamp.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Name of the Filestore instance backed up by the datasource. Format: projects/{project}/instances/{instance}", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"FinalizeBackupRequest": { +"description": "Message for finalizing a Backup.", +"id": "FinalizeBackupRequest", +"properties": { +"backupId": { +"description": "Required. Resource ID of the Backup resource to be finalized. This must be the same backup_id that was used in the InitiateBackupRequest.", +"type": "string" +}, +"consistencyTime": { +"description": "The point in time when this backup was captured from the source. This will be assigned to the consistency_time field of the newly created Backup.", +"format": "google-datetime", +"type": "string" +}, +"description": { +"description": "This will be assigned to the description field of the newly created Backup.", +"type": "string" +}, +"recoveryRangeEndTime": { +"description": "The latest timestamp of data available in this Backup. This will be set on the newly created Backup.", +"format": "google-datetime", +"type": "string" +}, +"recoveryRangeStartTime": { +"description": "The earliest timestamp of data available in this Backup. This will set on the newly created Backup.", +"format": "google-datetime", +"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).", +"type": "string" +}, +"retentionDuration": { +"description": "The ExpireTime on the backup will be set to FinalizeTime plus this duration. If the resulting ExpireTime is less than EnforcedRetentionEndTime, then ExpireTime is set to EnforcedRetentionEndTime.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"GCPBackupPlanInfo": { +"description": "GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup.", +"id": "GCPBackupPlanInfo", +"properties": { +"backupPlan": { +"description": "Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}", +"type": "string" +}, +"backupPlanRevisionId": { +"description": "The user friendly id of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup.", +"type": "string" +}, +"backupPlanRevisionName": { +"description": "Resource name of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}/revisions/{revisionId}", +"type": "string" +}, +"backupPlanRuleId": { +"description": "The rule id of the backup plan which triggered this backup in case of scheduled backup or used for", +"type": "string" +} +}, +"type": "object" +}, +"GcpBackupConfig": { +"description": "GcpBackupConfig captures the Backup configuration details for Google Cloud resources. All Google Cloud resources regardless of type are protected with backup plan associations.", +"id": "GcpBackupConfig", +"properties": { +"autoProtectionPolicyBinding": { +"description": "Output only. The resource name of the `AutoProtectionPolicyBinding` that manages this datasource, if any. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}`.", +"readOnly": true, +"type": "string" +}, +"backupPlan": { +"description": "The name of the backup plan.", +"type": "string" +}, +"backupPlanAssociation": { +"description": "The name of the backup plan association.", +"type": "string" +}, +"backupPlanDescription": { +"description": "The description of the backup plan.", +"type": "string" +}, +"backupPlanRevisionId": { +"description": "The user friendly id of the backup plan revision. E.g. v0, v1 etc.", +"type": "string" +}, +"backupPlanRevisionName": { +"description": "The name of the backup plan revision.", +"type": "string" +}, +"backupPlanRules": { +"description": "The names of the backup plan rules which point to this backupvault", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudBackupdrV1betaOperationMetadata": { +"description": "Represents the metadata of the long-running operation.", +"id": "GoogleCloudBackupdrV1betaOperationMetadata", +"properties": { +"additionalInfo": { +"additionalProperties": { +"type": "string" +}, +"description": "Output only. AdditionalInfo contains additional Info related to backup plan association resource.", +"readOnly": true, +"type": "object" +}, +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to 'Code.CANCELLED'.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GuestOsFeature": { +"description": "Feature type of the Guest OS.", +"id": "GuestOsFeature", +"properties": { +"type": { +"description": "The ID of a supported feature.", +"enum": [ +"FEATURE_TYPE_UNSPECIFIED", +"VIRTIO_SCSI_MULTIQUEUE", +"WINDOWS", +"MULTI_IP_SUBNET", +"UEFI_COMPATIBLE", +"SECURE_BOOT", +"GVNIC", +"SEV_CAPABLE", +"BARE_METAL_LINUX_COMPATIBLE", +"SUSPEND_RESUME_COMPATIBLE", +"SEV_LIVE_MIGRATABLE", +"SEV_SNP_CAPABLE", +"TDX_CAPABLE", +"IDPF", +"SEV_LIVE_MIGRATABLE_V2" +], +"enumDescriptions": [ +"Default value, which is unused.", +"VIRTIO_SCSI_MULTIQUEUE feature type.", +"WINDOWS feature type.", +"MULTI_IP_SUBNET feature type.", +"UEFI_COMPATIBLE feature type.", +"SECURE_BOOT feature type.", +"GVNIC feature type.", +"SEV_CAPABLE feature type.", +"BARE_METAL_LINUX_COMPATIBLE feature type.", +"SUSPEND_RESUME_COMPATIBLE feature type.", +"SEV_LIVE_MIGRATABLE feature type.", +"SEV_SNP_CAPABLE feature type.", +"TDX_CAPABLE feature type.", +"IDPF feature type.", +"SEV_LIVE_MIGRATABLE_V2 feature type." +], +"type": "string" +} +}, +"type": "object" +}, +"InitializeParams": { +"description": "Specifies the parameters to initialize this disk.", +"id": "InitializeParams", +"properties": { +"diskName": { +"description": "Optional. Specifies the disk name. If not specified, the default is to use the name of the instance.", +"type": "string" +}, +"replicaZones": { +"description": "Optional. URL of the zone where the disk should be created. Required for each regional disk associated with the instance.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"InitializeServiceRequest": { +"description": "Request message for initializing the service.", +"id": "InitializeServiceRequest", +"properties": { +"backupPlanLocation": { +"description": "Optional. The location where the BackupPlan will be created. This field is required for multi-region BackupVaults and is optional for regional BackupVaults. It is useful when creating a Backup Vault in a multi-region, allowing the BackupPlan to reside in a specific region within that multi-region. If this field is not provided, the BackupPlan will be created in the same location as specified in the `name` field.", +"type": "string" +}, +"cloudSqlInstanceInitializationConfig": { +"$ref": "CloudSqlInstanceInitializationConfig", +"description": "Optional. The configuration for initializing a Cloud SQL instance." +}, +"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 t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"type": "string" +}, +"resourceType": { +"description": "Required. The resource type to which the default service config will be applied. Examples include, \"compute.googleapis.com/Instance\" and \"storage.googleapis.com/Bucket\".", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, validates the request and returns the result, but does not actually run it.", +"type": "boolean" +} +}, +"type": "object" +}, +"InitiateBackupRequest": { +"description": "request message for InitiateBackup.", +"id": "InitiateBackupRequest", +"properties": { +"backupId": { +"description": "Required. Resource ID of the Backup resource.", +"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).", +"type": "string" +} +}, +"type": "object" +}, +"InitiateBackupResponse": { +"description": "Response message for InitiateBackup.", +"id": "InitiateBackupResponse", +"properties": { +"backup": { +"description": "The name of the backup that was created.", +"type": "string" +}, +"baseBackupGenerationId": { +"description": "The generation id of the base backup. It is needed for the incremental backups.", +"format": "int32", +"type": "integer" +}, +"newBackupGenerationId": { +"description": "The generation id of the new backup.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"InitiateDeleteAutoProtectionPolicyBindingRequest": { +"description": "Request message for initiating delete of an AutoProtectionPolicyBinding.", +"id": "InitiateDeleteAutoProtectionPolicyBindingRequest", +"properties": {}, +"type": "object" +}, +"InstanceParams": { +"description": "Additional instance params.", +"id": "InstanceParams", +"properties": { +"resourceManagerTags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Resource manager tags to be bound to the instance.", +"type": "object" +} +}, +"type": "object" +}, +"KeyValuePair": { +"description": "KeyValuePair defines a key-value pair for matching resource labels.", +"id": "KeyValuePair", +"properties": { +"key": { +"description": "Required. The key of the label to match. This must be in the format `{label_key}`. The key must match the regex Format:`\\p{Ll}\\p{Lo}{0,62}`.", +"type": "string" +}, +"values": { +"description": "Required. The values of the label to match. There will be explicit \u201cOR\u201d between values of array. Each value must be in the format `{label_value}`. The value must match the regex Format: `[\\\\p{Ll}\\\\p{Lo}\\\\p{N}_-]{1,63}`.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListAppliedAutoProtectionPoliciesResponse": { +"description": "Response message for ListAppliedAutoProtectionPolicies.", +"id": "ListAppliedAutoProtectionPoliciesResponse", +"properties": { +"appliedAutoProtectionPolicies": { +"description": "A list of the AppliedAutoProtectionPolicy resources found.", +"items": { +"$ref": "AppliedAutoProtectionPolicy" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as `page_token` to retrieve the next page.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListAutoProtectionPoliciesResponse": { +"description": "Response message for ListAutoProtectionPolicies.", +"id": "ListAutoProtectionPoliciesResponse", +"properties": { +"autoProtectionPolicies": { +"description": "A list of the AutoProtectionPolicy resources found.", +"items": { +"$ref": "AutoProtectionPolicy" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListAutoProtectionPolicyBindingsResponse": { +"description": "Response message for ListAutoProtectionPolicyBindings.", +"id": "ListAutoProtectionPolicyBindingsResponse", +"properties": { +"autoProtectionPolicyBindings": { +"description": "A list of the AutoProtectionPolicyBindings resources found.", +"items": { +"$ref": "AutoProtectionPolicyBinding" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListBackupPlanAssociationsResponse": { +"description": "Response message for List BackupPlanAssociation", +"id": "ListBackupPlanAssociationsResponse", +"properties": { +"backupPlanAssociations": { +"description": "The list of Backup Plan Associations 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 plan associations in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", +"items": { +"$ref": "BackupPlanAssociation" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListBackupPlanRevisionsResponse": { +"description": "The response message for getting a list of `BackupPlanRevision`.", +"id": "ListBackupPlanRevisionsResponse", +"properties": { +"backupPlanRevisions": { +"description": "The list of `BackupPlanRevisions` in the project for the specified location. If the `{location}` value in the request is \"-\", the response contains a list of resources from all locations. In case any location is unreachable, the response will only return backup plans in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", +"items": { +"$ref": "BackupPlanRevision" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token which may be sent as page_token in a subsequent `ListBackupPlanRevisions` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListBackupPlansResponse": { +"description": "The response message for getting a list of `BackupPlan`.", +"id": "ListBackupPlansResponse", +"properties": { +"backupPlans": { +"description": "The list of `BackupPlans` in the project for the specified location. If the `{location}` value in the request is \"-\", the response contains a list of resources from all locations. In case any location is unreachable, the response will only return backup plans in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. BackupPlan", +"items": { +"$ref": "BackupPlan" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token which may be sent as page_token in a subsequent `ListBackupPlans` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListBackupVaultsResponse": { +"description": "Response message for listing BackupVaults.", +"id": "ListBackupVaultsResponse", +"properties": { +"backupVaults": { +"description": "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.", +"items": { +"$ref": "BackupVault" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListBackupsResponse": { +"description": "Response message for listing Backups.", +"id": "ListBackupsResponse", +"properties": { +"backups": { +"description": "The list of Backup instances in the project for the specified location. If the '{location}' value in the request is \"-\", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return data sources in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", +"items": { +"$ref": "Backup" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListBindingMatchingResourcesResponse": { +"description": "The response message for getting a list of `BindingMatchingResources`.", +"id": "ListBindingMatchingResourcesResponse", +"properties": { +"matchingResources": { +"description": "The list of `BindingMatchingResources` in the project,location for the specified binding.", +"items": { +"$ref": "BindingMatchingResource" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token which may be sent as page_token in a subsequent `ListBindingMatchingResources` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.", +"type": "string" +} +}, +"type": "object" +}, +"ListDataSourceReferencesResponse": { +"description": "Response for the ListDataSourceReferences method.", +"id": "ListDataSourceReferencesResponse", +"properties": { +"dataSourceReferences": { +"description": "The DataSourceReferences from the specified parent.", +"items": { +"$ref": "DataSourceReference" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListDataSourcesResponse": { +"description": "Response message for listing DataSources.", +"id": "ListDataSourcesResponse", +"properties": { +"dataSources": { +"description": "The list of DataSource instances in the project for the specified location. If the '{location}' value in the request is \"-\", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return data sources in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", +"items": { +"$ref": "DataSource" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "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" +}, +"ListManagementServersResponse": { +"description": "Response message for listing management servers.", +"id": "ListManagementServersResponse", +"properties": { +"managementServers": { +"description": "The list of ManagementServer 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 management servers in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", +"items": { +"$ref": "ManagementServer" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListOperationsResponse": { +"description": "The response message for Operations.ListOperations.", +"id": "ListOperationsResponse", +"properties": { +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +}, +"operations": { +"description": "A list of operations that matches the specified filter in the request.", +"items": { +"$ref": "Operation" +}, +"type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListResourceBackupConfigsResponse": { +"description": "Response for ListResourceBackupConfigs.", +"id": "ListResourceBackupConfigsResponse", +"properties": { +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"resourceBackupConfigs": { +"description": "The list of ResourceBackupConfigs for the specified scope.", +"items": { +"$ref": "ResourceBackupConfig" +}, +"type": "array" +} +}, +"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" +}, +"LocationMetadata": { +"id": "LocationMetadata", +"properties": { +"unsupportedFeatures": { +"description": "List of features that are not supported in the location.", +"items": { +"enum": [ +"FEATURE_UNSPECIFIED", +"MANAGEMENT_SERVER", +"COMPUTE_INSTANCE", +"PROTECTION_SUMMARY", +"DISK", +"CLOUD_SQL", +"ALLOY_DB", +"FILESTORE", +"BV_AF", +"CEP_MONITORING_COMPUTE_INSTANCE", +"CEP_MONITORING_DISK", +"BV_CUSTOM_PROBERS", +"FT_CUSTOM_PROBERS" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"Remove once parity achieved between BV_AF and BV_CUSTOM_PROBERS.", +"" +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ManagementServer": { +"description": "ManagementServer describes a single BackupDR ManagementServer instance.", +"id": "ManagementServer", +"properties": { +"baProxyUri": { +"description": "Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"createTime": { +"description": "Output only. The time when the instance was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. The description of the ManagementServer instance (2048 characters or less).", +"type": "string" +}, +"etag": { +"description": "Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go= If set to true, the MS is created in migration ready mode.", +"type": "object" +}, +"managementUri": { +"$ref": "ManagementURI", +"description": "Output only. The hostname or ip address of the exposed AGM endpoints, used by clients to connect to AGM/RD graphical user interface and APIs.", +"readOnly": true +}, +"name": { +"description": "Output only. Identifier. The resource name.", +"readOnly": true, +"type": "string" +}, +"networks": { +"description": "Optional. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported. This field is optional if MS is created without PSA", +"items": { +"$ref": "NetworkConfig" +}, +"type": "array" +}, +"oauth2ClientId": { +"description": "Output only. The OAuth 2.0 client id is required to make API calls to the Backup and DR instance API of this ManagementServer. This is the value that should be provided in the 'aud' field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken).", +"readOnly": true, +"type": "string" +}, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"state": { +"description": "Output only. The ManagementServer state.", +"enum": [ +"INSTANCE_STATE_UNSPECIFIED", +"CREATING", +"READY", +"UPDATING", +"DELETING", +"REPAIRING", +"MAINTENANCE", +"ERROR" +], +"enumDescriptions": [ +"State not set.", +"The instance is being created.", +"The instance has been created and is fully usable.", +"The instance configuration is being updated. Certain kinds of updates may cause the instance to become unusable while the update is in progress.", +"The instance is being deleted.", +"The instance is being repaired and may be unstable.", +"Maintenance is being performed on this instance.", +"The instance is experiencing an issue and might be unusable. You can get further details from the statusMessage field of Instance resource." +], +"readOnly": true, +"type": "string" +}, +"type": { +"description": "Optional. The type of the ManagementServer resource.", +"enum": [ +"INSTANCE_TYPE_UNSPECIFIED", +"BACKUP_RESTORE" +], +"enumDescriptions": [ +"Instance type is not mentioned.", +"Instance for backup and restore management (i.e., AGM)." +], +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the instance was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"workforceIdentityBasedManagementUri": { +"$ref": "WorkforceIdentityBasedManagementURI", +"description": "Output only. The hostnames of the exposed AGM endpoints for both types of user i.e. 1p and 3p, used to connect AGM/RM UI.", +"readOnly": true +}, +"workforceIdentityBasedOauth2ClientId": { +"$ref": "WorkforceIdentityBasedOAuth2ClientID", +"description": "Output only. The OAuth client IDs for both types of user i.e. 1p and 3p.", +"readOnly": true +} +}, +"type": "object" +}, +"ManagementURI": { +"description": "ManagementURI for the Management Server resource.", +"id": "ManagementURI", +"properties": { +"api": { +"description": "Output only. The ManagementServer AGM/RD API URL.", +"readOnly": true, +"type": "string" +}, +"webUi": { +"description": "Output only. The ManagementServer AGM/RD WebUI URL.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"MatchingCondition": { +"description": "MatchingCondition specifies a set of conditions for matching resources.", +"id": "MatchingCondition", +"properties": { +"labelCondition": { +"$ref": "KeyValuePair", +"description": "Optional. A condition that matches resources based on their labels. For MVP, this is limited to a single label match." +} +}, +"type": "object" +}, +"Metadata": { +"description": "A metadata key/value entry.", +"id": "Metadata", +"properties": { +"items": { +"description": "Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB.", +"items": { +"$ref": "Entry" +}, +"type": "array" +} +}, +"type": "object" +}, +"NetworkConfig": { +"description": "Network configuration for ManagementServer instance.", +"id": "NetworkConfig", +"properties": { +"network": { +"description": "Optional. The resource name of the Google Compute Engine VPC network to which the ManagementServer instance is connected.", +"type": "string" +}, +"peeringMode": { +"description": "Optional. The network connect mode of the ManagementServer instance. For this version, only PRIVATE_SERVICE_ACCESS is supported.", +"enum": [ +"PEERING_MODE_UNSPECIFIED", +"PRIVATE_SERVICE_ACCESS" +], +"enumDescriptions": [ +"Peering mode not set.", +"Connect using Private Service Access to the Management Server. Private services access provides an IP address range for multiple Google Cloud services, including Google Cloud Backup and DR." +], +"type": "string" +} +}, +"type": "object" +}, +"NetworkInterface": { +"description": "A network interface resource attached to an instance. s", +"id": "NetworkInterface", +"properties": { +"accessConfigs": { +"description": "Optional. An array of configurations for this interface. Currently, only one access config,ONE_TO_ONE_NAT is supported. If there are no accessConfigs specified, then this instance will have no external internet access.", +"items": { +"$ref": "AccessConfig" +}, +"type": "array" +}, +"aliasIpRanges": { +"description": "Optional. An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.", +"items": { +"$ref": "AliasIpRange" +}, +"type": "array" +}, +"internalIpv6PrefixLength": { +"description": "Optional. The prefix length of the primary internal IPv6 range.", +"format": "int32", +"type": "integer" +}, +"ipv6AccessConfigs": { +"description": "Optional. An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.", +"items": { +"$ref": "AccessConfig" +}, +"type": "array" +}, +"ipv6AccessType": { +"description": "Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.", +"enum": [ +"UNSPECIFIED_IPV6_ACCESS_TYPE", +"INTERNAL", +"EXTERNAL" +], +"enumDescriptions": [ +"IPv6 access type not set. Means this network interface hasn't been turned on IPv6 yet.", +"This network interface can have internal IPv6.", +"This network interface can have external IPv6." +], +"type": "string" +}, +"ipv6Address": { +"description": "Optional. An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.", +"type": "string" +}, +"name": { +"description": "Output only. [Output Only] The name of the network interface, which is generated by the server.", +"readOnly": true, +"type": "string" +}, +"network": { +"description": "Optional. URL of the VPC network resource for this instance.", +"type": "string" +}, +"networkAttachment": { +"description": "Optional. The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.", +"type": "string" +}, +"networkIP": { +"description": "Optional. An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.", +"type": "string" +}, +"nicType": { +"description": "Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.", +"enum": [ +"NIC_TYPE_UNSPECIFIED", +"VIRTIO_NET", +"GVNIC" +], +"enumDescriptions": [ +"Default should be NIC_TYPE_UNSPECIFIED.", +"VIRTIO", +"GVNIC" +], +"type": "string" +}, +"queueCount": { +"description": "Optional. The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.", +"format": "int32", +"type": "integer" +}, +"stackType": { +"description": "The stack type for this network interface.", +"enum": [ +"STACK_TYPE_UNSPECIFIED", +"IPV4_ONLY", +"IPV4_IPV6" +], +"enumDescriptions": [ +"Default should be STACK_TYPE_UNSPECIFIED.", +"The network interface will be assigned IPv4 address.", +"The network interface can have both IPv4 and IPv6 addresses." +], +"type": "string" +}, +"subnetwork": { +"description": "Optional. The URL of the Subnetwork resource for this instance.", +"type": "string" +} +}, +"type": "object" +}, +"NetworkPerformanceConfig": { +"description": "Network performance configuration.", +"id": "NetworkPerformanceConfig", +"properties": { +"totalEgressBandwidthTier": { +"description": "Optional. The tier of the total egress bandwidth.", +"enum": [ +"TIER_UNSPECIFIED", +"DEFAULT", +"TIER_1" +], +"enumDescriptions": [ +"This value is unused.", +"Default network performance config.", +"Tier 1 network performance config." +], +"type": "string" +} +}, +"type": "object" +}, +"NodeAffinity": { +"description": "Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.", +"id": "NodeAffinity", +"properties": { +"key": { +"description": "Optional. Corresponds to the label key of Node resource.", +"type": "string" +}, +"operator": { +"description": "Optional. Defines the operation of node selection.", +"enum": [ +"OPERATOR_UNSPECIFIED", +"IN", +"NOT_IN" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Requires Compute Engine to seek for matched nodes.", +"Requires Compute Engine to avoid certain nodes." +], +"type": "string" +}, +"values": { +"description": "Optional. Corresponds to the label values of Node resource.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"Operation": { +"description": "This resource represents a long-running operation that is the result of a network API call.", +"id": "Operation", +"properties": { +"done": { +"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", +"type": "boolean" +}, +"error": { +"$ref": "Status", +"description": "The error result of the operation in case of failure or cancellation." +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", +"type": "object" +}, +"name": { +"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", +"type": "string" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", +"type": "object" +} +}, +"type": "object" +}, +"OperationMetadata": { +"description": "Represents the metadata of the long-running operation.", +"id": "OperationMetadata", +"properties": { +"additionalInfo": { +"additionalProperties": { +"type": "string" +}, +"description": "Output only. AdditionalInfo contains additional Info related to backup plan association resource.", +"readOnly": true, +"type": "object" +}, +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to 'Code.CANCELLED'.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"PitrSettings": { +"description": "Point in time recovery settings of the backup configuration resource.", +"id": "PitrSettings", +"properties": { +"retentionDays": { +"description": "Output only. Number of days to retain the backup.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"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" +}, +"PolicyEvaluationSummary": { +"description": "PolicyEvaluationSummary contains the summary of the last run of job that applies policy to matching resources.", +"id": "PolicyEvaluationSummary", +"properties": { +"failedResourceCount": { +"description": "Output only. The number of matching resources whose protection failed during job run.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"matchingResourceCount": { +"description": "Output only. The number of resources that currently match the policy's criteria.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"protectedResourceCount": { +"description": "Output only. The number of matching resources that are successfully protected.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ReconciliationOperationMetadata": { +"description": "Operation metadata returned by the CLH during resource state reconciliation.", +"id": "ReconciliationOperationMetadata", +"properties": { +"deleteResource": { +"deprecated": true, +"description": "DEPRECATED. Use exclusive_action instead.", +"type": "boolean" +}, +"exclusiveAction": { +"description": "Excluisive action returned by the CLH.", +"enum": [ +"UNKNOWN_REPAIR_ACTION", +"DELETE", +"RETRY" +], +"enumDeprecated": [ +false, +true, +false +], +"enumDescriptions": [ +"Unknown repair action.", +"The resource has to be deleted. When using this bit, the CLH should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE OperationSignal in SideChannel.", +"This resource could not be repaired but the repair should be tried again at a later time. This can happen if there is a dependency that needs to be resolved first- e.g. if a parent resource must be repaired before a child resource." +], +"type": "string" +} +}, +"type": "object" +}, +"RegionDiskTargetEnvironment": { +"description": "RegionDiskTargetEnvironment represents the target environment for the disk.", +"id": "RegionDiskTargetEnvironment", +"properties": { +"project": { +"description": "Required. Target project for the disk.", +"type": "string" +}, +"region": { +"description": "Required. Target region for the disk.", +"type": "string" +}, +"replicaZones": { +"description": "Required. Target URLs of the replica zones for the disk.", +"items": { +"type": "string" +}, +"type": "array" +}, +"useProjectServiceAccount": { +"description": "Optional. Whether to use the project service account for the disk restore.", +"type": "boolean" +} +}, +"type": "object" +}, +"RemoveDataSourceRequest": { +"description": "Message for deleting a DataSource.", +"id": "RemoveDataSourceRequest", +"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. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"type": "string" +} +}, +"type": "object" +}, +"ResourceBackupConfig": { +"description": "ResourceBackupConfig represents a resource along with its backup configurations.", +"id": "ResourceBackupConfig", +"properties": { +"backupConfigsDetails": { +"description": "Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.", +"items": { +"$ref": "BackupConfigDetails" +}, +"type": "array" +}, +"backupConfigured": { +"description": "Output only. Whether the target resource is configured for backup. This is true if the backup_configs_details is not empty.", +"readOnly": true, +"type": "boolean" +}, +"name": { +"description": "Identifier. The resource name of the ResourceBackupConfig. Format: projects/{project}/locations/{location}/resourceBackupConfigs/{uid}", +"type": "string" +}, +"targetResource": { +"description": "Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the cloud resource that this configuration applies to. Supported resource types are ResourceBackupConfig.ResourceType.", +"readOnly": true, +"type": "string" +}, +"targetResourceDisplayName": { +"description": "Output only. The human friendly name of the target resource.", +"readOnly": true, +"type": "string" +}, +"targetResourceLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "Labels associated with the target resource.", +"type": "object" +}, +"targetResourceType": { +"description": "Output only. The type of the target resource.", +"enum": [ +"RESOURCE_TYPE_UNSPECIFIED", +"CLOUD_SQL_INSTANCE", +"COMPUTE_ENGINE_VM", +"COMPUTE_ENGINE_DISK", +"COMPUTE_ENGINE_REGIONAL_DISK", +"FILESTORE_INSTANCE" +], +"enumDescriptions": [ +"Resource type not set.", +"Cloud SQL instance.", +"Compute Engine VM.", +"Compute Engine Disk.", +"Compute Engine Regional Disk.", +"Filestore Instance." +], +"readOnly": true, +"type": "string" +}, +"uid": { +"description": "Output only. The unique identifier of the resource backup config.", +"readOnly": true, +"type": "string" +}, +"vaulted": { +"description": "Output only. Whether the target resource is protected by a backup vault. This is true if the backup_configs_details is not empty and any of the ResourceBackupConfig.backup_configs_details has a backup configuration with BackupConfigDetails.backup_vault set.", +"readOnly": true, +"type": "boolean" +} +}, +"type": "object" +}, +"RestoreBackupRequest": { +"description": "Request message for restoring from a Backup.", +"id": "RestoreBackupRequest", +"properties": { +"clearOverridesFieldMask": { +"description": "Optional. A field mask used to clear server-side default values for fields within the `instance_properties` oneof. When a field in this mask is cleared, the server will not apply its default logic (like inheriting a value from the source) for that field. The most common current use case is clearing default encryption keys. Examples of field mask paths: - Compute Instance Disks: `compute_instance_restore_properties.disks.*.disk_encryption_key` - Single Disk: `disk_restore_properties.disk_encryption_key`", +"format": "google-fieldmask", +"type": "string" +}, +"computeInstanceRestoreProperties": { +"$ref": "ComputeInstanceRestoreProperties", +"description": "Compute Engine instance properties to be overridden during restore." +}, +"computeInstanceTargetEnvironment": { +"$ref": "ComputeInstanceTargetEnvironment", +"description": "Compute Engine target environment to be used during restore." +}, +"diskRestoreProperties": { +"$ref": "DiskRestoreProperties", +"description": "Disk properties to be overridden during restore." +}, +"diskTargetEnvironment": { +"$ref": "DiskTargetEnvironment", +"description": "Disk target environment to be used during restore." +}, +"regionDiskTargetEnvironment": { +"$ref": "RegionDiskTargetEnvironment", +"description": "Region disk target environment to be used during restore." +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"type": "string" +} +}, +"type": "object" +}, +"RestoreDiskFromInstanceOptions": { +"description": "Options for creating a disk from a source Compute Instance backup.", +"id": "RestoreDiskFromInstanceOptions", +"properties": { +"bootDisk": { +"description": "Set to true to restore the boot disk from the instance backup. This field should only be set to true if selected.", +"type": "boolean" +}, +"sourceDeviceName": { +"description": "The device name of the disk to restore from the VM backup.", +"type": "string" +} +}, +"type": "object" +}, +"RuleConfigInfo": { +"description": "Message for rules config info.", +"id": "RuleConfigInfo", +"properties": { +"lastBackupError": { +"$ref": "Status", +"description": "Output only. google.rpc.Status object to store the last backup error.", +"readOnly": true +}, +"lastBackupState": { +"description": "Output only. The last backup state for rule.", +"enum": [ +"LAST_BACKUP_STATE_UNSPECIFIED", +"FIRST_BACKUP_PENDING", +"PERMISSION_DENIED", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"State not set.", +"The first backup is pending.", +"The most recent backup could not be run/failed because of the lack of permissions.", +"The last backup operation succeeded.", +"The last backup operation failed." +], +"readOnly": true, +"type": "string" +}, +"lastSuccessfulBackupConsistencyTime": { +"description": "Output only. The point in time when the last successful backup was captured from the source.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"ruleId": { +"description": "Output only. Backup Rule id fetched from backup plan.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Scheduling": { +"description": "Sets the scheduling options for an Instance.", +"id": "Scheduling", +"properties": { +"automaticRestart": { +"description": "Optional. Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).", +"type": "boolean" +}, +"instanceTerminationAction": { +"description": "Optional. Specifies the termination action for the instance.", +"enum": [ +"INSTANCE_TERMINATION_ACTION_UNSPECIFIED", +"DELETE", +"STOP" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Delete the VM.", +"Stop the VM without storing in-memory content. default action." +], +"type": "string" +}, +"localSsdRecoveryTimeout": { +"$ref": "SchedulingDuration", +"description": "Optional. Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour." +}, +"minNodeCpus": { +"description": "Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.", +"format": "int32", +"type": "integer" +}, +"nodeAffinities": { +"description": "Optional. A set of node affinity and anti-affinity configurations. Overrides reservationAffinity.", +"items": { +"$ref": "NodeAffinity" +}, +"type": "array" +}, +"onHostMaintenance": { +"description": "Optional. Defines the maintenance behavior for this instance.", +"enum": [ +"ON_HOST_MAINTENANCE_UNSPECIFIED", +"TERMINATE", +"MIGRATE" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity.", +"Default, Allows Compute Engine to automatically migrate instances out of the way of maintenance events." +], +"type": "string" +}, +"preemptible": { +"description": "Optional. Defines whether the instance is preemptible.", +"type": "boolean" +}, +"provisioningModel": { +"description": "Optional. Specifies the provisioning model of the instance.", +"enum": [ +"PROVISIONING_MODEL_UNSPECIFIED", +"STANDARD", +"SPOT" +], +"enumDescriptions": [ +"Default value. This value is not used.", +"Standard provisioning with user controlled runtime, no discounts.", +"Heavily discounted, no guaranteed runtime." +], +"type": "string" +} +}, +"type": "object" +}, +"SchedulingDuration": { +"description": "A SchedulingDuration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like \"day\" or \"month\". Range is approximately 10,000 years.", +"id": "SchedulingDuration", +"properties": { +"nanos": { +"description": "Optional. Span of time that's a fraction of a second at nanosecond resolution.", +"format": "int32", +"type": "integer" +}, +"seconds": { +"description": "Optional. Span of time at a resolution of a second.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"ServiceAccount": { +"description": "A service account.", +"id": "ServiceAccount", +"properties": { +"email": { +"description": "Optional. Email address of the service account.", +"type": "string" +}, +"scopes": { +"description": "Optional. The list of scopes to be made available for this service account.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ServiceLockInfo": { +"description": "ServiceLockInfo represents the details of a lock taken by the service on a Backup resource.", +"id": "ServiceLockInfo", +"properties": { +"operation": { +"description": "Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes.", +"readOnly": true, +"type": "string" +} +}, +"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" +}, +"SetInternalStatusRequest": { +"description": "Request message for SetStatusInternal method.", +"id": "SetInternalStatusRequest", +"properties": { +"backupConfigState": { +"description": "Required. Output only. The new BackupConfigState to set for the DataSource.", +"enum": [ +"BACKUP_CONFIG_STATE_UNSPECIFIED", +"ACTIVE", +"PASSIVE" +], +"enumDescriptions": [ +"The possible states of backup configuration. Status not set.", +"The data source is actively protected (i.e. there is a BackupPlanAssociation or Appliance SLA pointing to it)", +"The data source is no longer protected (but may have backups under it)" +], +"readOnly": 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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"type": "string" +}, +"value": { +"description": "Required. The value required for this method to work. This field must be the 32-byte SHA256 hash of the DataSourceID. The DataSourceID used here is only the final piece of the fully qualified resource path for this DataSource (i.e. the part after '.../dataSources/'). This field exists to make this method difficult to call since it is intended for use only by Backup Appliances.", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, +"StandardSchedule": { +"description": "`StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY.", +"id": "StandardSchedule", +"properties": { +"backupWindow": { +"$ref": "BackupWindow", +"description": "Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window." +}, +"daysOfMonth": { +"description": "Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values for `days_of_month` are only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"daysOfWeek": { +"description": "Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`.", +"items": { +"enum": [ +"DAY_OF_WEEK_UNSPECIFIED", +"MONDAY", +"TUESDAY", +"WEDNESDAY", +"THURSDAY", +"FRIDAY", +"SATURDAY", +"SUNDAY" +], +"enumDescriptions": [ +"The day of the week is unspecified.", +"Monday", +"Tuesday", +"Wednesday", +"Thursday", +"Friday", +"Saturday", +"Sunday" +], +"type": "string" +}, +"type": "array" +}, +"hourlyFrequency": { +"description": "Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 1-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details.", +"format": "int32", +"type": "integer" +}, +"months": { +"description": "Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied.", +"items": { +"enum": [ +"MONTH_UNSPECIFIED", +"JANUARY", +"FEBRUARY", +"MARCH", +"APRIL", +"MAY", +"JUNE", +"JULY", +"AUGUST", +"SEPTEMBER", +"OCTOBER", +"NOVEMBER", +"DECEMBER" +], +"enumDescriptions": [ +"The unspecified month.", +"The month of January.", +"The month of February.", +"The month of March.", +"The month of April.", +"The month of May.", +"The month of June.", +"The month of July.", +"The month of August.", +"The month of September.", +"The month of October.", +"The month of November.", +"The month of December." +], +"type": "string" +}, +"type": "array" +}, +"recurrenceType": { +"description": "Required. Specifies the `RecurrenceType` for the schedule.", +"enum": [ +"RECURRENCE_TYPE_UNSPECIFIED", +"HOURLY", +"DAILY", +"WEEKLY", +"MONTHLY", +"YEARLY" +], +"enumDescriptions": [ +"recurrence type not set", +"The `BackupRule` is to be applied hourly.", +"The `BackupRule` is to be applied daily.", +"The `BackupRule` is to be applied weekly.", +"The `BackupRule` is to be applied monthly.", +"The `BackupRule` is to be applied yearly." +], +"type": "string" +}, +"timeZone": { +"description": "Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.", +"type": "string" +}, +"weekDayOfMonth": { +"$ref": "WeekDayOfMonth", +"description": "Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, e.g. `LAST`. This field is only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied." +} +}, +"type": "object" +}, +"Status": { +"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", +"id": "Status", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", +"type": "string" +} +}, +"type": "object" +}, +"SubscribeTrialRequest": { +"description": "Request message for subscribing to a trial.", +"id": "SubscribeTrialRequest", +"properties": {}, +"type": "object" +}, +"Tags": { +"description": "A set of instance tags.", +"id": "Tags", +"properties": { +"items": { +"description": "Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"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" +}, +"Trial": { +"description": "Represents a Trial for a project.", +"id": "Trial", +"properties": { +"endReason": { +"description": "Output only. The reason for ending the trial.", +"enum": [ +"END_REASON_UNSPECIFIED", +"MOVE_TO_PAID", +"DISCONTINUED" +], +"enumDescriptions": [ +"End reason not set.", +"Trial is deliberately ended by the user to transition to paid usage.", +"Trial is discontinued before expiration." +], +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time when the trial will expire.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the trial. Format: projects/{project}/locations/{location}/trial", +"type": "string" +}, +"startTime": { +"description": "Output only. The time when the trial was subscribed.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The state of the trial.", +"enum": [ +"STATE_UNSPECIFIED", +"SUBSCRIBED", +"UNSUBSCRIBED", +"EXPIRED", +"ELIGIBLE", +"NOT_ELIGIBLE" +], +"enumDescriptions": [ +"State not set.", +"Trial is subscribed.", +"Trial is unsubscribed before expiration.", +"Trial is expired post 30 days of subscription.", +"Trial is eligible for enablement.", +"Trial is not eligible for enablement." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"TriggerBackupRequest": { +"description": "Request message for triggering a backup.", +"id": "TriggerBackupRequest", +"properties": { +"customRetentionDays": { +"description": "Optional. The duration for which backup data will be kept, while taking an on-demand backup with custom retention. It is defined in \"days\". It is mutually exclusive with rule_id. This field is required if rule_id is not provided.", +"format": "int32", +"type": "integer" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels to be applied on the backup.", +"type": "object" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"type": "string" +}, +"ruleId": { +"description": "Optional. backup rule_id for which a backup needs to be triggered. If not specified, on-demand backup with custom retention will be triggered.", +"type": "string" +} +}, +"type": "object" +}, +"WeekDayOfMonth": { +"description": "`WeekDayOfMonth` defines the week day of the month on which the backups will run. The message combines a `WeekOfMonth` and `DayOfWeek` to produce values like `FIRST`/`MONDAY` or `LAST`/`FRIDAY`.", +"id": "WeekDayOfMonth", +"properties": { +"dayOfWeek": { +"description": "Required. Specifies the day of the week.", +"enum": [ +"DAY_OF_WEEK_UNSPECIFIED", +"MONDAY", +"TUESDAY", +"WEDNESDAY", +"THURSDAY", +"FRIDAY", +"SATURDAY", +"SUNDAY" +], +"enumDescriptions": [ +"The day of the week is unspecified.", +"Monday", +"Tuesday", +"Wednesday", +"Thursday", +"Friday", +"Saturday", +"Sunday" +], +"type": "string" +}, +"weekOfMonth": { +"description": "Required. Specifies the week of the month.", +"enum": [ +"WEEK_OF_MONTH_UNSPECIFIED", +"FIRST", +"SECOND", +"THIRD", +"FOURTH", +"LAST" +], +"enumDescriptions": [ +"The zero value. Do not use.", +"The first week of the month.", +"The second week of the month.", +"The third week of the month.", +"The fourth week of the month.", +"The last week of the month." +], +"type": "string" +} +}, +"type": "object" +}, +"WorkforceIdentityBasedManagementURI": { +"description": "ManagementURI depending on the Workforce Identity i.e. either 1p or 3p.", +"id": "WorkforceIdentityBasedManagementURI", +"properties": { +"firstPartyManagementUri": { +"description": "Output only. First party Management URI for Google Identities.", +"readOnly": true, +"type": "string" +}, +"thirdPartyManagementUri": { +"description": "Output only. Third party Management URI for External Identity Providers.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"WorkforceIdentityBasedOAuth2ClientID": { +"description": "OAuth Client ID depending on the Workforce Identity i.e. either 1p or 3p,", +"id": "WorkforceIdentityBasedOAuth2ClientID", +"properties": { +"firstPartyOauth2ClientId": { +"description": "Output only. First party OAuth Client ID for Google Identities.", +"readOnly": true, +"type": "string" +}, +"thirdPartyOauth2ClientId": { +"description": "Output only. Third party OAuth Client ID for External Identity Providers.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Backup and DR Service API", +"version": "v1beta", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index 652b223c46..16ee254f81 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -221,7 +221,7 @@ } } }, -"revision": "20260901", +"revision": "20260902", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AddDocumentTabRequest": { @@ -1077,7 +1077,7 @@ "type": "string" }, "tabs": { -"description": "Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field.", +"description": "Output only. Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field.", "items": { "$ref": "Tab" }, diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index 7d2de2adb5..8944b633c2 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -2596,7 +2596,7 @@ } } }, -"revision": "20260817", +"revision": "20260903", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -6819,7 +6819,7 @@ "type": "object" }, "Rollout": { -"description": "Rollout contains the Rollout metadata and configuration. Next ID: 31", +"description": "Rollout contains the Rollout metadata and configuration. Next ID: 32", "id": "Rollout", "properties": { "completeTime": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index 6748393744..cb55b917fb 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -2740,7 +2740,7 @@ } } }, -"revision": "20260817", +"revision": "20260903", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -7332,7 +7332,7 @@ "type": "object" }, "Rollout": { -"description": "Rollout contains the Rollout metadata and configuration. Next ID: 31", +"description": "Rollout contains the Rollout metadata and configuration. Next ID: 32", "id": "Rollout", "properties": { "completeTime": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index 1c6d33fa2e..339a20fd56 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -2596,7 +2596,7 @@ } } }, -"revision": "20260817", +"revision": "20260903", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -6945,7 +6945,7 @@ "type": "object" }, "Rollout": { -"description": "Rollout contains the Rollout metadata and configuration. Next ID: 31", +"description": "Rollout contains the Rollout metadata and configuration. Next ID: 32", "id": "Rollout", "properties": { "completeTime": { diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json index df0a962715..0da1d54af4 100644 --- a/googleapiclient/discovery_cache/documents/iam.v1.json +++ b/googleapiclient/discovery_cache/documents/iam.v1.json @@ -4341,7 +4341,7 @@ } } }, -"revision": "20260828", +"revision": "20260904", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -6520,11 +6520,13 @@ false "description": "Optional. Gemini Enterprise only. Specifies whether the workforce identity pool provider uses SCIM-managed groups instead of the `google.groups` attribute mapping for authorization checks. The `scim_usage` and `extended_attributes_oauth2_client` fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error.", "enum": [ "SCIM_USAGE_UNSPECIFIED", -"ENABLED_FOR_GROUPS" +"ENABLED_FOR_GROUPS", +"ENABLED_FOR_USERS_GROUPS" ], "enumDescriptions": [ -"Gemini Enterprise only. Do not use SCIM data.", -"Gemini Enterprise only. SCIM sync is enabled and SCIM-managed groups are used for authorization checks." +"Indicates that SCIM data is not used.", +"Gemini Enterprise only. SCIM sync is enabled and SCIM-managed groups are used for authorization checks.", +"Looker only. SCIM sync is enabled, and SCIM-managed user claims and groups are used for authorization checks." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1.json index b7617ccb85..9725cf9e07 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1.json @@ -6141,7 +6141,7 @@ } } }, -"revision": "20260824", +"revision": "20260910", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -6702,7 +6702,7 @@ "id": "AuthzPolicyAuthzRuleToRequestOperationMCP", "properties": { "baseProtocolMethodsOption": { -"description": "Optional. If specified, matches on the MCP protocol\u2019s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified.", +"description": "Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified.", "enum": [ "BASE_PROTOCOL_METHODS_OPTION_UNSPECIFIED", "SKIP_BASE_PROTOCOL_METHODS", diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json index 51fcee5e85..2a68eebe9c 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json @@ -6346,7 +6346,7 @@ } } }, -"revision": "20260824", +"revision": "20260910", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -6907,7 +6907,7 @@ "id": "AuthzPolicyAuthzRuleToRequestOperationMCP", "properties": { "baseProtocolMethodsOption": { -"description": "Optional. If specified, matches on the MCP protocol\u2019s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified.", +"description": "Optional. If specified, matches on the MCP protocol's non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified.", "enum": [ "BASE_PROTOCOL_METHODS_OPTION_UNSPECIFIED", "SKIP_BASE_PROTOCOL_METHODS", diff --git a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json index fa80f5512a..83267f74c0 100644 --- a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json +++ b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json @@ -549,7 +549,7 @@ "type": "string" }, "updateMask": { -"description": "Optional. Field mask is used to specify the fields to be overwritten in the Exadata resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"description": "Optional. Field mask is used to specify the fields to be overwritten in the Exadata resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the service treats this as an implied field mask equivalent to all fields that are populated (have a non-empty value). To clear or unset a field, the field must be explicitly specified in the `update_mask`.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1770,7 +1770,7 @@ "type": "string" }, "updateMask": { -"description": "Optional. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then all the fields in the VM Cluster are overwritten.", +"description": "Optional. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then the service treats this as an implied field mask equivalent to all fields that are populated (have a non-empty value). To clear or unset a field, the field must be explicitly specified in the `update_mask`.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3278,7 +3278,7 @@ } } }, -"revision": "20260810", +"revision": "20260910", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json index 6adccd2b89..eb84b93567 100644 --- a/googleapiclient/discovery_cache/documents/storage.v1.json +++ b/googleapiclient/discovery_cache/documents/storage.v1.json @@ -253,7 +253,7 @@ "location": "northamerica-south1" } ], -"etag": "\"3138323634323934313536353633333331373333\"", +"etag": "\"35383135343338383530313436313234313131\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -4731,7 +4731,7 @@ } } }, -"revision": "20260821", +"revision": "20260911", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AdvanceRelocateBucketOperationRequest": { @@ -6524,6 +6524,10 @@ "format": "date-time", "type": "string" }, +"extendedDataTypeUrl": { +"description": "The type URL of the object context's extended data.", +"type": "string" +}, "updateTime": { "description": "The time at which the object context was last updated in RFC 3339 format.", "format": "date-time",